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.
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure};
17 use routing::router::{Route, get_route};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use ln::features::InitFeatures;
21 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
22 use util::enforcing_trait_impls::EnforcingSigner;
24 use util::test_utils::TestChainMonitor;
25 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
26 use util::errors::APIError;
27 use util::config::UserConfig;
28 use util::ser::{ReadableArgs, Writeable, Readable};
30 use bitcoin::blockdata::block::{Block, BlockHeader};
31 use bitcoin::blockdata::constants::genesis_block;
32 use bitcoin::blockdata::transaction::{Transaction, TxOut};
33 use bitcoin::network::constants::Network;
35 use bitcoin::hashes::sha256::Hash as Sha256;
36 use bitcoin::hashes::Hash;
37 use bitcoin::hash_types::BlockHash;
39 use bitcoin::secp256k1::key::PublicKey;
41 use std::cell::RefCell;
45 use std::collections::HashMap;
47 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
49 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
50 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
51 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
52 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
53 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
55 /// Mine a signle block containing the given transaction
56 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
57 let height = node.best_block_info().1 + 1;
58 confirm_transaction_at(node, tx, height);
60 /// Mine the given transaction at the given height, mining blocks as required to build to that
62 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
63 let starting_block = node.best_block_info();
64 let mut block = Block {
65 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
68 let height = starting_block.1 + 1;
69 assert!(height <= conf_height);
70 for _ in height..conf_height {
71 connect_block(node, &block);
73 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
78 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
79 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
81 block.txdata.push(tx.clone());
82 connect_block(node, &block);
85 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
86 let mut block = Block {
87 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
90 connect_block(node, &block);
91 for _ in 2..depth + 1 {
93 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
96 connect_block(node, &block);
98 block.header.block_hash()
101 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
102 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
103 let height = node.best_block_info().1 + 1;
104 node.chain_monitor.chain_monitor.block_connected(&block.header, &txdata, height);
105 node.node.block_connected(&block.header, &txdata, height);
106 node.node.test_process_background_events();
107 node.blocks.borrow_mut().push((block.header, height));
110 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
112 let orig_header = node.blocks.borrow_mut().pop().unwrap();
113 assert!(orig_header.1 > 0); // Cannot disconnect genesis
114 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
115 node.node.block_disconnected(&orig_header.0);
119 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
120 let count = node.blocks.borrow_mut().len() as u32 - 1;
121 disconnect_blocks(node, count);
124 pub struct TestChanMonCfg {
125 pub tx_broadcaster: test_utils::TestBroadcaster,
126 pub fee_estimator: test_utils::TestFeeEstimator,
127 pub chain_source: test_utils::TestChainSource,
128 pub persister: test_utils::TestPersister,
129 pub logger: test_utils::TestLogger,
130 pub keys_manager: test_utils::TestKeysInterface,
133 pub struct NodeCfg<'a> {
134 pub chain_source: &'a test_utils::TestChainSource,
135 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
136 pub fee_estimator: &'a test_utils::TestFeeEstimator,
137 pub chain_monitor: test_utils::TestChainMonitor<'a>,
138 pub keys_manager: &'a test_utils::TestKeysInterface,
139 pub logger: &'a test_utils::TestLogger,
140 pub node_seed: [u8; 32],
143 pub struct Node<'a, 'b: 'a, 'c: 'b> {
144 pub chain_source: &'c test_utils::TestChainSource,
145 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
146 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
147 pub keys_manager: &'b test_utils::TestKeysInterface,
148 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
149 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
150 pub node_seed: [u8; 32],
151 pub network_payment_count: Rc<RefCell<u8>>,
152 pub network_chan_count: Rc<RefCell<u32>>,
153 pub logger: &'c test_utils::TestLogger,
154 pub blocks: RefCell<Vec<(BlockHeader, u32)>>,
156 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
157 pub fn best_block_hash(&self) -> BlockHash {
158 self.blocks.borrow_mut().last().unwrap().0.block_hash()
160 pub fn best_block_info(&self) -> (BlockHash, u32) {
161 self.blocks.borrow_mut().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
165 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
167 if !::std::thread::panicking() {
168 // Check that we processed all pending events
169 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
170 assert!(self.node.get_and_clear_pending_events().is_empty());
171 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
173 // Check that if we serialize the Router, we can deserialize it again.
175 let mut w = test_utils::TestVecWriter(Vec::new());
176 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
177 network_graph_ser.write(&mut w).unwrap();
178 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
179 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
180 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
181 Some(self.chain_source), self.logger, network_graph_deser
183 let mut chan_progress = 0;
185 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
186 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
187 assert!(orig_announcements == deserialized_announcements);
188 chan_progress = match orig_announcements.last() {
189 Some(announcement) => announcement.0.contents.short_channel_id + 1,
193 let mut node_progress = None;
195 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
196 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
197 assert!(orig_announcements == deserialized_announcements);
198 node_progress = match orig_announcements.last() {
199 Some(announcement) => Some(announcement.contents.node_id),
205 // Check that if we serialize and then deserialize all our channel monitors we get the
206 // same set of outputs to watch for on chain as we have now. Note that if we write
207 // tests that fully close channels and remove the monitors at some point this may break.
208 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
209 let mut deserialized_monitors = Vec::new();
211 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
212 for (_, old_monitor) in old_monitors.iter() {
213 let mut w = test_utils::TestVecWriter(Vec::new());
214 old_monitor.write(&mut w).unwrap();
215 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
216 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap();
217 deserialized_monitors.push(deserialized_monitor);
221 // Before using all the new monitors to check the watch outpoints, use the full set of
222 // them to ensure we can write and reload our ChannelManager.
224 let mut channel_monitors = HashMap::new();
225 for monitor in deserialized_monitors.iter_mut() {
226 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
229 let mut w = test_utils::TestVecWriter(Vec::new());
230 self.node.write(&mut w).unwrap();
231 <(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 {
232 default_config: UserConfig::default(),
233 keys_manager: self.keys_manager,
234 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
235 chain_monitor: self.chain_monitor,
236 tx_broadcaster: &test_utils::TestBroadcaster {
237 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
239 logger: &test_utils::TestLogger::new(),
244 let persister = test_utils::TestPersister::new();
245 let broadcaster = test_utils::TestBroadcaster {
246 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
248 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
249 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
250 for deserialized_monitor in deserialized_monitors.drain(..) {
251 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
255 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
256 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
261 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) {
262 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
265 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) {
266 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);
267 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
268 (announcement, as_update, bs_update, channel_id, tx)
271 macro_rules! get_revoke_commit_msgs {
272 ($node: expr, $node_id: expr) => {
274 let events = $node.node.get_and_clear_pending_msg_events();
275 assert_eq!(events.len(), 2);
277 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
278 assert_eq!(*node_id, $node_id);
281 _ => panic!("Unexpected event"),
283 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
284 assert_eq!(*node_id, $node_id);
285 assert!(updates.update_add_htlcs.is_empty());
286 assert!(updates.update_fulfill_htlcs.is_empty());
287 assert!(updates.update_fail_htlcs.is_empty());
288 assert!(updates.update_fail_malformed_htlcs.is_empty());
289 assert!(updates.update_fee.is_none());
290 updates.commitment_signed.clone()
292 _ => panic!("Unexpected event"),
298 /// Get an specific event message from the pending events queue.
300 macro_rules! get_event_msg {
301 ($node: expr, $event_type: path, $node_id: expr) => {
303 let events = $node.node.get_and_clear_pending_msg_events();
304 assert_eq!(events.len(), 1);
306 $event_type { ref node_id, ref msg } => {
307 assert_eq!(*node_id, $node_id);
310 _ => panic!("Unexpected event"),
317 macro_rules! get_htlc_update_msgs {
318 ($node: expr, $node_id: expr) => {
320 let events = $node.node.get_and_clear_pending_msg_events();
321 assert_eq!(events.len(), 1);
323 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
324 assert_eq!(*node_id, $node_id);
327 _ => panic!("Unexpected event"),
334 macro_rules! get_feerate {
335 ($node: expr, $channel_id: expr) => {
337 let chan_lock = $node.node.channel_state.lock().unwrap();
338 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
345 macro_rules! get_local_commitment_txn {
346 ($node: expr, $channel_id: expr) => {
348 let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
349 let mut commitment_txn = None;
350 for (funding_txo, monitor) in monitors.iter() {
351 if funding_txo.to_channel_id() == $channel_id {
352 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
356 commitment_txn.unwrap()
361 /// Check the error from attempting a payment.
363 macro_rules! unwrap_send_err {
364 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
366 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
367 assert_eq!(fails.len(), 1);
373 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
374 assert_eq!(fails.len(), 1);
376 Err($type) => { $check },
385 /// Check whether N channel monitor(s) have been added.
387 macro_rules! check_added_monitors {
388 ($node: expr, $count: expr) => {
390 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
391 assert_eq!(added_monitors.len(), $count);
392 added_monitors.clear();
397 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) {
398 let chan_id = *node.network_chan_count.borrow();
400 let events = node.node.get_and_clear_pending_events();
401 assert_eq!(events.len(), 1);
403 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
404 assert_eq!(*channel_value_satoshis, expected_chan_value);
405 assert_eq!(user_channel_id, expected_user_chan_id);
407 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
408 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
410 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
411 (*temporary_channel_id, tx, funding_outpoint)
413 _ => panic!("Unexpected event"),
417 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 {
418 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
419 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()));
420 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()));
422 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
424 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
425 check_added_monitors!(node_a, 0);
427 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()));
429 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
430 assert_eq!(added_monitors.len(), 1);
431 assert_eq!(added_monitors[0].0, funding_output);
432 added_monitors.clear();
435 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()));
437 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
438 assert_eq!(added_monitors.len(), 1);
439 assert_eq!(added_monitors[0].0, funding_output);
440 added_monitors.clear();
443 let events_4 = node_a.node.get_and_clear_pending_events();
444 assert_eq!(events_4.len(), 1);
446 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
447 assert_eq!(user_channel_id, 42);
448 assert_eq!(*funding_txo, funding_output);
450 _ => panic!("Unexpected event"),
456 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) {
457 confirm_transaction_at(node_conf, tx, conf_height);
458 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
459 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()));
462 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]) {
464 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
465 assert_eq!(events_6.len(), 2);
466 ((match events_6[0] {
467 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
468 channel_id = msg.channel_id.clone();
469 assert_eq!(*node_id, node_recv.node.get_our_node_id());
472 _ => panic!("Unexpected event"),
473 }, match events_6[1] {
474 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
475 assert_eq!(*node_id, node_recv.node.get_our_node_id());
478 _ => panic!("Unexpected event"),
482 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]) {
483 let conf_height = std::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
484 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
485 confirm_transaction_at(node_a, tx, conf_height);
486 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
487 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
490 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) {
491 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
492 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
496 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) {
497 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
498 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
499 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
501 let events_7 = node_b.node.get_and_clear_pending_msg_events();
502 assert_eq!(events_7.len(), 1);
503 let (announcement, bs_update) = match events_7[0] {
504 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
507 _ => panic!("Unexpected event"),
510 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
511 let events_8 = node_a.node.get_and_clear_pending_msg_events();
512 assert_eq!(events_8.len(), 1);
513 let as_update = match events_8[0] {
514 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
515 assert!(*announcement == *msg);
516 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
517 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
520 _ => panic!("Unexpected event"),
523 *node_a.network_chan_count.borrow_mut() += 1;
525 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
528 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) {
529 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
532 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) {
533 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
534 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
535 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
538 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) {
539 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
540 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
541 assert_eq!(a_events.len(), 1);
542 let a_node_announcement = match a_events[0] {
543 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
546 _ => panic!("Unexpected event"),
549 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
550 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
551 assert_eq!(b_events.len(), 1);
552 let b_node_announcement = match b_events[0] {
553 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
556 _ => panic!("Unexpected event"),
560 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
561 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
562 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
563 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
564 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
568 macro_rules! check_spends {
569 ($tx: expr, $($spends_txn: expr),*) => {
571 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
573 if out_point.txid == $spends_txn.txid() {
574 return $spends_txn.output.get(out_point.vout as usize).cloned()
579 let mut total_value_in = 0;
580 for input in $tx.input.iter() {
581 total_value_in += get_output(&input.previous_output).unwrap().value;
583 let mut total_value_out = 0;
584 for output in $tx.output.iter() {
585 total_value_out += output.value;
587 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
588 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
589 assert!(total_value_out + min_fee <= total_value_in);
590 $tx.verify(get_output).unwrap();
595 macro_rules! get_closing_signed_broadcast {
596 ($node: expr, $dest_pubkey: expr) => {
598 let events = $node.get_and_clear_pending_msg_events();
599 assert!(events.len() == 1 || events.len() == 2);
600 (match events[events.len() - 1] {
601 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
602 assert_eq!(msg.contents.flags & 2, 2);
605 _ => panic!("Unexpected event"),
606 }, if events.len() == 2 {
608 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
609 assert_eq!(*node_id, $dest_pubkey);
612 _ => panic!("Unexpected event"),
619 /// Check that a channel's closing channel update has been broadcasted, and optionally
620 /// check whether an error message event has occurred.
622 macro_rules! check_closed_broadcast {
623 ($node: expr, $with_error_msg: expr) => {{
624 let events = $node.node.get_and_clear_pending_msg_events();
625 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
627 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
628 assert_eq!(msg.contents.flags & 2, 2);
630 _ => panic!("Unexpected event"),
634 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
635 // TODO: Check node_id
638 _ => panic!("Unexpected event"),
644 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) {
645 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) };
646 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
649 node_a.close_channel(channel_id).unwrap();
650 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()));
652 let events_1 = node_b.get_and_clear_pending_msg_events();
653 assert!(events_1.len() >= 1);
654 let shutdown_b = match events_1[0] {
655 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
656 assert_eq!(node_id, &node_a.get_our_node_id());
659 _ => panic!("Unexpected event"),
662 let closing_signed_b = if !close_inbound_first {
663 assert_eq!(events_1.len(), 1);
666 Some(match events_1[1] {
667 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
668 assert_eq!(node_id, &node_a.get_our_node_id());
671 _ => panic!("Unexpected event"),
675 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
676 let (as_update, bs_update) = if close_inbound_first {
677 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
678 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
679 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
680 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
681 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
683 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
684 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
685 assert!(none_b.is_none());
686 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
687 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
688 (as_update, bs_update)
690 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
692 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
693 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
694 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
695 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
697 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
698 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
699 assert!(none_a.is_none());
700 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
701 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
702 (as_update, bs_update)
704 assert_eq!(tx_a, tx_b);
705 check_spends!(tx_a, funding_tx);
707 (as_update, bs_update, tx_a)
710 pub struct SendEvent {
711 pub node_id: PublicKey,
712 pub msgs: Vec<msgs::UpdateAddHTLC>,
713 pub commitment_msg: msgs::CommitmentSigned,
716 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
717 assert!(updates.update_fulfill_htlcs.is_empty());
718 assert!(updates.update_fail_htlcs.is_empty());
719 assert!(updates.update_fail_malformed_htlcs.is_empty());
720 assert!(updates.update_fee.is_none());
721 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
724 pub fn from_event(event: MessageSendEvent) -> SendEvent {
726 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
727 _ => panic!("Unexpected event type!"),
731 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
732 let mut events = node.node.get_and_clear_pending_msg_events();
733 assert_eq!(events.len(), 1);
734 SendEvent::from_event(events.pop().unwrap())
738 macro_rules! commitment_signed_dance {
739 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
741 check_added_monitors!($node_a, 0);
742 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
743 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
744 check_added_monitors!($node_a, 1);
745 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
748 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
750 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
751 check_added_monitors!($node_b, 0);
752 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
753 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
754 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
755 check_added_monitors!($node_b, 1);
756 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
757 let (bs_revoke_and_ack, extra_msg_option) = {
758 let events = $node_b.node.get_and_clear_pending_msg_events();
759 assert!(events.len() <= 2);
761 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
762 assert_eq!(*node_id, $node_a.node.get_our_node_id());
765 _ => panic!("Unexpected event"),
766 }, events.get(1).map(|e| e.clone()))
768 check_added_monitors!($node_b, 1);
770 assert!($node_a.node.get_and_clear_pending_events().is_empty());
771 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
773 (extra_msg_option, bs_revoke_and_ack)
776 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
778 check_added_monitors!($node_a, 0);
779 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
780 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
781 check_added_monitors!($node_a, 1);
782 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
783 assert!(extra_msg_option.is_none());
787 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
789 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
790 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
791 check_added_monitors!($node_a, 1);
795 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
797 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
800 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
802 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
804 expect_pending_htlcs_forwardable!($node_a);
805 check_added_monitors!($node_a, 1);
807 let channel_state = $node_a.node.channel_state.lock().unwrap();
808 assert_eq!(channel_state.pending_msg_events.len(), 1);
809 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
810 assert_ne!(*node_id, $node_b.node.get_our_node_id());
811 } else { panic!("Unexpected event"); }
813 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
819 /// Get a payment preimage and hash.
821 macro_rules! get_payment_preimage_hash {
824 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
825 *$node.network_payment_count.borrow_mut() += 1;
826 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
827 (payment_preimage, payment_hash)
832 macro_rules! expect_pending_htlcs_forwardable_ignore {
834 let events = $node.node.get_and_clear_pending_events();
835 assert_eq!(events.len(), 1);
837 Event::PendingHTLCsForwardable { .. } => { },
838 _ => panic!("Unexpected event"),
843 macro_rules! expect_pending_htlcs_forwardable {
845 expect_pending_htlcs_forwardable_ignore!($node);
846 $node.node.process_pending_htlc_forwards();
851 macro_rules! expect_payment_received {
852 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
853 let events = $node.node.get_and_clear_pending_events();
854 assert_eq!(events.len(), 1);
856 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
857 assert_eq!($expected_payment_hash, *payment_hash);
858 assert_eq!(None, *payment_secret);
859 assert_eq!($expected_recv_value, amt);
861 _ => panic!("Unexpected event"),
866 macro_rules! expect_payment_sent {
867 ($node: expr, $expected_payment_preimage: expr) => {
868 let events = $node.node.get_and_clear_pending_events();
869 assert_eq!(events.len(), 1);
871 Event::PaymentSent { ref payment_preimage } => {
872 assert_eq!($expected_payment_preimage, *payment_preimage);
874 _ => panic!("Unexpected event"),
880 macro_rules! expect_payment_failed {
881 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
882 let events = $node.node.get_and_clear_pending_events();
883 assert_eq!(events.len(), 1);
885 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
886 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
887 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
888 assert!(error_code.is_some(), "expected error_code.is_some() = true");
889 assert!(error_data.is_some(), "expected error_data.is_some() = true");
891 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
892 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
895 _ => panic!("Unexpected event"),
900 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>) {
901 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
902 check_added_monitors!(origin_node, expected_paths.len());
903 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
906 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) {
907 let mut payment_event = SendEvent::from_event(ev);
908 let mut prev_node = origin_node;
910 for (idx, &node) in expected_path.iter().enumerate() {
911 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
913 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
914 check_added_monitors!(node, 0);
915 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
917 expect_pending_htlcs_forwardable!(node);
919 if idx == expected_path.len() - 1 {
920 let events_2 = node.node.get_and_clear_pending_events();
921 if payment_received_expected {
922 assert_eq!(events_2.len(), 1);
924 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
925 assert_eq!(our_payment_hash, *payment_hash);
926 assert_eq!(our_payment_secret, *payment_secret);
927 assert_eq!(amt, recv_value);
929 _ => panic!("Unexpected event"),
932 assert!(events_2.is_empty());
935 let mut events_2 = node.node.get_and_clear_pending_msg_events();
936 assert_eq!(events_2.len(), 1);
937 check_added_monitors!(node, 1);
938 payment_event = SendEvent::from_event(events_2.remove(0));
939 assert_eq!(payment_event.msgs.len(), 1);
946 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>) {
947 let mut events = origin_node.node.get_and_clear_pending_msg_events();
948 assert_eq!(events.len(), expected_route.len());
949 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
950 // Once we've gotten through all the HTLCs, the last one should result in a
951 // PaymentReceived (but each previous one should not!), .
952 let expect_payment = path_idx == expected_route.len() - 1;
953 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
957 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) {
958 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
961 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) {
962 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
963 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
964 (our_payment_preimage, our_payment_hash)
967 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) {
968 for path in expected_paths.iter() {
969 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
971 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
972 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
974 macro_rules! msgs_from_ev {
977 &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 } } => {
978 assert!(update_add_htlcs.is_empty());
979 assert_eq!(update_fulfill_htlcs.len(), 1);
980 assert!(update_fail_htlcs.is_empty());
981 assert!(update_fail_malformed_htlcs.is_empty());
982 assert!(update_fee.is_none());
983 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
985 _ => panic!("Unexpected event"),
989 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
990 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
991 assert_eq!(events.len(), expected_paths.len());
992 for ev in events.iter() {
993 per_path_msgs.push(msgs_from_ev!(ev));
996 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
997 let mut next_msgs = Some(path_msgs);
998 let mut expected_next_node = next_hop;
1000 macro_rules! last_update_fulfill_dance {
1001 ($node: expr, $prev_node: expr) => {
1003 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1004 check_added_monitors!($node, 0);
1005 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1006 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1010 macro_rules! mid_update_fulfill_dance {
1011 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1013 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1014 check_added_monitors!($node, 1);
1015 let new_next_msgs = if $new_msgs {
1016 let events = $node.node.get_and_clear_pending_msg_events();
1017 assert_eq!(events.len(), 1);
1018 let (res, nexthop) = msgs_from_ev!(&events[0]);
1019 expected_next_node = nexthop;
1022 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1025 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1026 next_msgs = new_next_msgs;
1031 let mut prev_node = expected_route.last().unwrap();
1032 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1033 assert_eq!(expected_next_node, node.node.get_our_node_id());
1034 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1035 if next_msgs.is_some() {
1036 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1038 assert!(!update_next_msgs);
1039 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1041 if !skip_last && idx == expected_route.len() - 1 {
1042 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1049 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1050 expect_payment_sent!(origin_node, our_payment_preimage);
1055 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) {
1056 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1059 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) {
1060 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1063 pub const TEST_FINAL_CLTV: u32 = 50;
1065 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1066 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1067 let logger = test_utils::TestLogger::new();
1068 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();
1069 assert_eq!(route.paths.len(), 1);
1070 assert_eq!(route.paths[0].len(), expected_route.len());
1071 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1072 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1075 send_along_route(origin_node, route, expected_route, recv_value)
1078 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1079 let logger = test_utils::TestLogger::new();
1080 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1081 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();
1082 assert_eq!(route.paths.len(), 1);
1083 assert_eq!(route.paths[0].len(), expected_route.len());
1084 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1085 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1088 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1089 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1090 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1093 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
1094 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1095 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1098 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) {
1099 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1100 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1101 check_added_monitors!(expected_route.last().unwrap(), 1);
1103 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1104 macro_rules! update_fail_dance {
1105 ($node: expr, $prev_node: expr, $last_node: expr) => {
1107 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1108 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1109 if skip_last && $last_node {
1110 expect_pending_htlcs_forwardable!($node);
1116 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1117 let mut prev_node = expected_route.last().unwrap();
1118 for (idx, node) in expected_route.iter().rev().enumerate() {
1119 assert_eq!(expected_next_node, node.node.get_our_node_id());
1120 if next_msgs.is_some() {
1121 // We may be the "last node" for the purpose of the commitment dance if we're
1122 // skipping the last node (implying it is disconnected) and we're the
1123 // second-to-last node!
1124 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1127 let events = node.node.get_and_clear_pending_msg_events();
1128 if !skip_last || idx != expected_route.len() - 1 {
1129 assert_eq!(events.len(), 1);
1131 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 } } => {
1132 assert!(update_add_htlcs.is_empty());
1133 assert!(update_fulfill_htlcs.is_empty());
1134 assert_eq!(update_fail_htlcs.len(), 1);
1135 assert!(update_fail_malformed_htlcs.is_empty());
1136 assert!(update_fee.is_none());
1137 expected_next_node = node_id.clone();
1138 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1140 _ => panic!("Unexpected event"),
1143 assert!(events.is_empty());
1145 if !skip_last && idx == expected_route.len() - 1 {
1146 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1153 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1155 let events = origin_node.node.get_and_clear_pending_events();
1156 assert_eq!(events.len(), 1);
1158 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1159 assert_eq!(payment_hash, our_payment_hash);
1160 assert!(rejected_by_dest);
1162 _ => panic!("Unexpected event"),
1167 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1168 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1171 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1172 let mut chan_mon_cfgs = Vec::new();
1173 for i in 0..node_count {
1174 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1175 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1176 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1177 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1178 let persister = test_utils::TestPersister::new();
1179 let seed = [i as u8; 32];
1180 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1182 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1188 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1189 let mut nodes = Vec::new();
1191 for i in 0..node_count {
1192 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);
1193 let seed = [i as u8; 32];
1194 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 });
1200 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>> {
1201 let mut chanmgrs = Vec::new();
1202 for i in 0..node_count {
1203 let mut default_config = UserConfig::default();
1204 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1205 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1206 default_config.channel_options.cltv_expiry_delta = 6*6;
1207 default_config.channel_options.announced_channel = true;
1208 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1209 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
1210 let network = Network::Testnet;
1211 let params = ChainParameters {
1213 latest_hash: genesis_block(network).header.block_hash(),
1216 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);
1217 chanmgrs.push(node);
1223 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>> {
1224 let mut nodes = Vec::new();
1225 let chan_count = Rc::new(RefCell::new(0));
1226 let payment_count = Rc::new(RefCell::new(0));
1228 for i in 0..node_count {
1229 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1230 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1231 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1232 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1233 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1234 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1235 blocks: RefCell::new(vec![(genesis_block(Network::Testnet).header, 0)])
1242 // Note that the following only works for CLTV values up to 128
1243 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1244 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1246 #[derive(PartialEq)]
1247 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1248 /// Tests that the given node has broadcast transactions for the given Channel
1250 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1251 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1252 /// broadcast and the revoked outputs were claimed.
1254 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1255 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1257 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1259 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> {
1260 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1261 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1263 let mut res = Vec::with_capacity(2);
1264 node_txn.retain(|tx| {
1265 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1266 check_spends!(tx, chan.3);
1267 if commitment_tx.is_none() {
1268 res.push(tx.clone());
1273 if let Some(explicit_tx) = commitment_tx {
1274 res.push(explicit_tx.clone());
1277 assert_eq!(res.len(), 1);
1279 if has_htlc_tx != HTLCType::NONE {
1280 node_txn.retain(|tx| {
1281 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1282 check_spends!(tx, res[0]);
1283 if has_htlc_tx == HTLCType::TIMEOUT {
1284 assert!(tx.lock_time != 0);
1286 assert!(tx.lock_time == 0);
1288 res.push(tx.clone());
1292 assert!(res.len() == 2 || res.len() == 3);
1294 assert_eq!(res[1], res[2]);
1298 assert!(node_txn.is_empty());
1302 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1303 /// HTLC transaction.
1304 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1305 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1306 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1307 // for revoked htlc outputs
1308 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1309 node_txn.retain(|tx| {
1310 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1311 check_spends!(tx, revoked_tx);
1315 node_txn.retain(|tx| {
1316 check_spends!(tx, commitment_revoked_tx);
1319 assert!(node_txn.is_empty());
1322 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1323 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1325 assert!(node_txn.len() >= 1);
1326 assert_eq!(node_txn[0].input.len(), 1);
1327 let mut found_prev = false;
1329 for tx in prev_txn {
1330 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1331 check_spends!(node_txn[0], tx);
1332 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1333 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1339 assert!(found_prev);
1341 let mut res = Vec::new();
1342 mem::swap(&mut *node_txn, &mut res);
1346 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1347 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1348 assert_eq!(events_1.len(), 2);
1349 let as_update = match events_1[0] {
1350 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1353 _ => panic!("Unexpected event"),
1356 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1357 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1358 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1360 _ => panic!("Unexpected event"),
1363 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1364 assert_eq!(events_2.len(), 2);
1365 let bs_update = match events_2[0] {
1366 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1369 _ => panic!("Unexpected event"),
1372 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1373 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1374 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1376 _ => panic!("Unexpected event"),
1380 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1381 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1386 macro_rules! get_channel_value_stat {
1387 ($node: expr, $channel_id: expr) => {{
1388 let chan_lock = $node.node.channel_state.lock().unwrap();
1389 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1390 chan.get_value_stat()
1394 macro_rules! get_chan_reestablish_msgs {
1395 ($src_node: expr, $dst_node: expr) => {
1397 let mut res = Vec::with_capacity(1);
1398 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1399 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1400 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1401 res.push(msg.clone());
1403 panic!("Unexpected event")
1411 macro_rules! handle_chan_reestablish_msgs {
1412 ($src_node: expr, $dst_node: expr) => {
1414 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1416 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1418 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1424 let mut revoke_and_ack = None;
1425 let mut commitment_update = None;
1426 let order = if let Some(ev) = msg_events.get(idx) {
1429 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1430 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1431 revoke_and_ack = Some(msg.clone());
1432 RAACommitmentOrder::RevokeAndACKFirst
1434 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1435 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1436 commitment_update = Some(updates.clone());
1437 RAACommitmentOrder::CommitmentFirst
1439 _ => panic!("Unexpected event"),
1442 RAACommitmentOrder::CommitmentFirst
1445 if let Some(ev) = msg_events.get(idx) {
1447 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1448 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1449 assert!(revoke_and_ack.is_none());
1450 revoke_and_ack = Some(msg.clone());
1452 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1453 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1454 assert!(commitment_update.is_none());
1455 commitment_update = Some(updates.clone());
1457 _ => panic!("Unexpected event"),
1461 (funding_locked, revoke_and_ack, commitment_update, order)
1466 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1467 /// for claims/fails they are separated out.
1468 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)) {
1469 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1470 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1471 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1472 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1474 if send_funding_locked.0 {
1475 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1477 for reestablish in reestablish_1.iter() {
1478 assert_eq!(reestablish.next_remote_commitment_number, 0);
1481 if send_funding_locked.1 {
1482 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1484 for reestablish in reestablish_2.iter() {
1485 assert_eq!(reestablish.next_remote_commitment_number, 0);
1488 if send_funding_locked.0 || send_funding_locked.1 {
1489 // If we expect any funding_locked's, both sides better have set
1490 // next_holder_commitment_number to 1
1491 for reestablish in reestablish_1.iter() {
1492 assert_eq!(reestablish.next_local_commitment_number, 1);
1494 for reestablish in reestablish_2.iter() {
1495 assert_eq!(reestablish.next_local_commitment_number, 1);
1499 let mut resp_1 = Vec::new();
1500 for msg in reestablish_1 {
1501 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1502 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1504 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1505 check_added_monitors!(node_b, 1);
1507 check_added_monitors!(node_b, 0);
1510 let mut resp_2 = Vec::new();
1511 for msg in reestablish_2 {
1512 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1513 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1515 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1516 check_added_monitors!(node_a, 1);
1518 check_added_monitors!(node_a, 0);
1521 // We don't yet support both needing updates, as that would require a different commitment dance:
1522 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1523 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1525 for chan_msgs in resp_1.drain(..) {
1526 if send_funding_locked.0 {
1527 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1528 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1529 if !announcement_event.is_empty() {
1530 assert_eq!(announcement_event.len(), 1);
1531 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1532 //TODO: Test announcement_sigs re-sending
1533 } else { panic!("Unexpected event!"); }
1536 assert!(chan_msgs.0.is_none());
1539 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1540 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1541 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1542 check_added_monitors!(node_a, 1);
1544 assert!(chan_msgs.1.is_none());
1546 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1547 let commitment_update = chan_msgs.2.unwrap();
1548 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1549 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1551 assert!(commitment_update.update_add_htlcs.is_empty());
1553 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1554 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1555 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1556 for update_add in commitment_update.update_add_htlcs {
1557 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1559 for update_fulfill in commitment_update.update_fulfill_htlcs {
1560 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1562 for update_fail in commitment_update.update_fail_htlcs {
1563 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1566 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1567 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1569 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1570 check_added_monitors!(node_a, 1);
1571 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1572 // No commitment_signed so get_event_msg's assert(len == 1) passes
1573 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1574 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1575 check_added_monitors!(node_b, 1);
1578 assert!(chan_msgs.2.is_none());
1582 for chan_msgs in resp_2.drain(..) {
1583 if send_funding_locked.1 {
1584 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1585 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1586 if !announcement_event.is_empty() {
1587 assert_eq!(announcement_event.len(), 1);
1588 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1589 //TODO: Test announcement_sigs re-sending
1590 } else { panic!("Unexpected event!"); }
1593 assert!(chan_msgs.0.is_none());
1596 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1597 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1598 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1599 check_added_monitors!(node_b, 1);
1601 assert!(chan_msgs.1.is_none());
1603 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1604 let commitment_update = chan_msgs.2.unwrap();
1605 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1606 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1608 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1609 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1610 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1611 for update_add in commitment_update.update_add_htlcs {
1612 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1614 for update_fulfill in commitment_update.update_fulfill_htlcs {
1615 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1617 for update_fail in commitment_update.update_fail_htlcs {
1618 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1621 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1622 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1624 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1625 check_added_monitors!(node_b, 1);
1626 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1627 // No commitment_signed so get_event_msg's assert(len == 1) passes
1628 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1629 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1630 check_added_monitors!(node_a, 1);
1633 assert!(chan_msgs.2.is_none());