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();
344 /// Returns any local commitment transactions for the channel.
346 macro_rules! get_local_commitment_txn {
347 ($node: expr, $channel_id: expr) => {
349 let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
350 let mut commitment_txn = None;
351 for (funding_txo, monitor) in monitors.iter() {
352 if funding_txo.to_channel_id() == $channel_id {
353 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
357 commitment_txn.unwrap()
362 /// Check the error from attempting a payment.
364 macro_rules! unwrap_send_err {
365 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
367 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
368 assert_eq!(fails.len(), 1);
374 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
375 assert_eq!(fails.len(), 1);
377 Err($type) => { $check },
386 /// Check whether N channel monitor(s) have been added.
388 macro_rules! check_added_monitors {
389 ($node: expr, $count: expr) => {
391 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
392 assert_eq!(added_monitors.len(), $count);
393 added_monitors.clear();
398 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) {
399 let chan_id = *node.network_chan_count.borrow();
401 let events = node.node.get_and_clear_pending_events();
402 assert_eq!(events.len(), 1);
404 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
405 assert_eq!(*channel_value_satoshis, expected_chan_value);
406 assert_eq!(user_channel_id, expected_user_chan_id);
408 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
409 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
411 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
412 (*temporary_channel_id, tx, funding_outpoint)
414 _ => panic!("Unexpected event"),
418 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 {
419 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
420 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()));
421 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()));
423 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
425 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
426 check_added_monitors!(node_a, 0);
428 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()));
430 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
431 assert_eq!(added_monitors.len(), 1);
432 assert_eq!(added_monitors[0].0, funding_output);
433 added_monitors.clear();
436 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()));
438 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
439 assert_eq!(added_monitors.len(), 1);
440 assert_eq!(added_monitors[0].0, funding_output);
441 added_monitors.clear();
444 let events_4 = node_a.node.get_and_clear_pending_events();
445 assert_eq!(events_4.len(), 1);
447 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
448 assert_eq!(user_channel_id, 42);
449 assert_eq!(*funding_txo, funding_output);
451 _ => panic!("Unexpected event"),
457 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) {
458 confirm_transaction_at(node_conf, tx, conf_height);
459 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
460 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()));
463 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]) {
465 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
466 assert_eq!(events_6.len(), 2);
467 ((match events_6[0] {
468 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
469 channel_id = msg.channel_id.clone();
470 assert_eq!(*node_id, node_recv.node.get_our_node_id());
473 _ => panic!("Unexpected event"),
474 }, match events_6[1] {
475 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
476 assert_eq!(*node_id, node_recv.node.get_our_node_id());
479 _ => panic!("Unexpected event"),
483 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]) {
484 let conf_height = std::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
485 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
486 confirm_transaction_at(node_a, tx, conf_height);
487 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
488 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
491 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) {
492 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
493 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
497 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) {
498 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
499 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
500 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
502 let events_7 = node_b.node.get_and_clear_pending_msg_events();
503 assert_eq!(events_7.len(), 1);
504 let (announcement, bs_update) = match events_7[0] {
505 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
508 _ => panic!("Unexpected event"),
511 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
512 let events_8 = node_a.node.get_and_clear_pending_msg_events();
513 assert_eq!(events_8.len(), 1);
514 let as_update = match events_8[0] {
515 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
516 assert!(*announcement == *msg);
517 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
518 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
521 _ => panic!("Unexpected event"),
524 *node_a.network_chan_count.borrow_mut() += 1;
526 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
529 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) {
530 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
533 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) {
534 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
535 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
536 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
539 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) {
540 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
541 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
542 assert_eq!(a_events.len(), 1);
543 let a_node_announcement = match a_events[0] {
544 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
547 _ => panic!("Unexpected event"),
550 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
551 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
552 assert_eq!(b_events.len(), 1);
553 let b_node_announcement = match b_events[0] {
554 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
557 _ => panic!("Unexpected event"),
561 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
562 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
563 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
564 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
565 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
569 macro_rules! check_spends {
570 ($tx: expr, $($spends_txn: expr),*) => {
572 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
574 if out_point.txid == $spends_txn.txid() {
575 return $spends_txn.output.get(out_point.vout as usize).cloned()
580 let mut total_value_in = 0;
581 for input in $tx.input.iter() {
582 total_value_in += get_output(&input.previous_output).unwrap().value;
584 let mut total_value_out = 0;
585 for output in $tx.output.iter() {
586 total_value_out += output.value;
588 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
589 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
590 assert!(total_value_out + min_fee <= total_value_in);
591 $tx.verify(get_output).unwrap();
596 macro_rules! get_closing_signed_broadcast {
597 ($node: expr, $dest_pubkey: expr) => {
599 let events = $node.get_and_clear_pending_msg_events();
600 assert!(events.len() == 1 || events.len() == 2);
601 (match events[events.len() - 1] {
602 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
603 assert_eq!(msg.contents.flags & 2, 2);
606 _ => panic!("Unexpected event"),
607 }, if events.len() == 2 {
609 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
610 assert_eq!(*node_id, $dest_pubkey);
613 _ => panic!("Unexpected event"),
620 /// Check that a channel's closing channel update has been broadcasted, and optionally
621 /// check whether an error message event has occurred.
623 macro_rules! check_closed_broadcast {
624 ($node: expr, $with_error_msg: expr) => {{
625 let events = $node.node.get_and_clear_pending_msg_events();
626 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
628 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
629 assert_eq!(msg.contents.flags & 2, 2);
631 _ => panic!("Unexpected event"),
635 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
636 // TODO: Check node_id
639 _ => panic!("Unexpected event"),
645 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) {
646 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) };
647 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
650 node_a.close_channel(channel_id).unwrap();
651 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()));
653 let events_1 = node_b.get_and_clear_pending_msg_events();
654 assert!(events_1.len() >= 1);
655 let shutdown_b = match events_1[0] {
656 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
657 assert_eq!(node_id, &node_a.get_our_node_id());
660 _ => panic!("Unexpected event"),
663 let closing_signed_b = if !close_inbound_first {
664 assert_eq!(events_1.len(), 1);
667 Some(match events_1[1] {
668 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
669 assert_eq!(node_id, &node_a.get_our_node_id());
672 _ => panic!("Unexpected event"),
676 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
677 let (as_update, bs_update) = if close_inbound_first {
678 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
679 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
680 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
681 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
682 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
684 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
685 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
686 assert!(none_b.is_none());
687 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
688 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
689 (as_update, bs_update)
691 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
693 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
694 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
695 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
696 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
698 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
699 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
700 assert!(none_a.is_none());
701 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
702 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
703 (as_update, bs_update)
705 assert_eq!(tx_a, tx_b);
706 check_spends!(tx_a, funding_tx);
708 (as_update, bs_update, tx_a)
711 pub struct SendEvent {
712 pub node_id: PublicKey,
713 pub msgs: Vec<msgs::UpdateAddHTLC>,
714 pub commitment_msg: msgs::CommitmentSigned,
717 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
718 assert!(updates.update_fulfill_htlcs.is_empty());
719 assert!(updates.update_fail_htlcs.is_empty());
720 assert!(updates.update_fail_malformed_htlcs.is_empty());
721 assert!(updates.update_fee.is_none());
722 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
725 pub fn from_event(event: MessageSendEvent) -> SendEvent {
727 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
728 _ => panic!("Unexpected event type!"),
732 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
733 let mut events = node.node.get_and_clear_pending_msg_events();
734 assert_eq!(events.len(), 1);
735 SendEvent::from_event(events.pop().unwrap())
739 macro_rules! commitment_signed_dance {
740 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
742 check_added_monitors!($node_a, 0);
743 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
744 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
745 check_added_monitors!($node_a, 1);
746 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
749 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
751 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
752 check_added_monitors!($node_b, 0);
753 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
754 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
755 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
756 check_added_monitors!($node_b, 1);
757 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
758 let (bs_revoke_and_ack, extra_msg_option) = {
759 let events = $node_b.node.get_and_clear_pending_msg_events();
760 assert!(events.len() <= 2);
762 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
763 assert_eq!(*node_id, $node_a.node.get_our_node_id());
766 _ => panic!("Unexpected event"),
767 }, events.get(1).map(|e| e.clone()))
769 check_added_monitors!($node_b, 1);
771 assert!($node_a.node.get_and_clear_pending_events().is_empty());
772 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
774 (extra_msg_option, bs_revoke_and_ack)
777 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
779 check_added_monitors!($node_a, 0);
780 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
781 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
782 check_added_monitors!($node_a, 1);
783 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
784 assert!(extra_msg_option.is_none());
788 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
790 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
791 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
792 check_added_monitors!($node_a, 1);
796 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
798 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
801 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
803 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
805 expect_pending_htlcs_forwardable!($node_a);
806 check_added_monitors!($node_a, 1);
808 let channel_state = $node_a.node.channel_state.lock().unwrap();
809 assert_eq!(channel_state.pending_msg_events.len(), 1);
810 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
811 assert_ne!(*node_id, $node_b.node.get_our_node_id());
812 } else { panic!("Unexpected event"); }
814 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
820 /// Get a payment preimage and hash.
822 macro_rules! get_payment_preimage_hash {
825 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
826 *$node.network_payment_count.borrow_mut() += 1;
827 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
828 (payment_preimage, payment_hash)
833 macro_rules! expect_pending_htlcs_forwardable_ignore {
835 let events = $node.node.get_and_clear_pending_events();
836 assert_eq!(events.len(), 1);
838 Event::PendingHTLCsForwardable { .. } => { },
839 _ => panic!("Unexpected event"),
844 macro_rules! expect_pending_htlcs_forwardable {
846 expect_pending_htlcs_forwardable_ignore!($node);
847 $node.node.process_pending_htlc_forwards();
852 macro_rules! expect_payment_received {
853 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
854 let events = $node.node.get_and_clear_pending_events();
855 assert_eq!(events.len(), 1);
857 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
858 assert_eq!($expected_payment_hash, *payment_hash);
859 assert_eq!(None, *payment_secret);
860 assert_eq!($expected_recv_value, amt);
862 _ => panic!("Unexpected event"),
867 macro_rules! expect_payment_sent {
868 ($node: expr, $expected_payment_preimage: expr) => {
869 let events = $node.node.get_and_clear_pending_events();
870 assert_eq!(events.len(), 1);
872 Event::PaymentSent { ref payment_preimage } => {
873 assert_eq!($expected_payment_preimage, *payment_preimage);
875 _ => panic!("Unexpected event"),
881 macro_rules! expect_payment_failed {
882 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
883 let events = $node.node.get_and_clear_pending_events();
884 assert_eq!(events.len(), 1);
886 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
887 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
888 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
889 assert!(error_code.is_some(), "expected error_code.is_some() = true");
890 assert!(error_data.is_some(), "expected error_data.is_some() = true");
892 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
893 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
896 _ => panic!("Unexpected event"),
901 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>) {
902 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
903 check_added_monitors!(origin_node, expected_paths.len());
904 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
907 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) {
908 let mut payment_event = SendEvent::from_event(ev);
909 let mut prev_node = origin_node;
911 for (idx, &node) in expected_path.iter().enumerate() {
912 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
914 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
915 check_added_monitors!(node, 0);
916 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
918 expect_pending_htlcs_forwardable!(node);
920 if idx == expected_path.len() - 1 {
921 let events_2 = node.node.get_and_clear_pending_events();
922 if payment_received_expected {
923 assert_eq!(events_2.len(), 1);
925 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
926 assert_eq!(our_payment_hash, *payment_hash);
927 assert_eq!(our_payment_secret, *payment_secret);
928 assert_eq!(amt, recv_value);
930 _ => panic!("Unexpected event"),
933 assert!(events_2.is_empty());
936 let mut events_2 = node.node.get_and_clear_pending_msg_events();
937 assert_eq!(events_2.len(), 1);
938 check_added_monitors!(node, 1);
939 payment_event = SendEvent::from_event(events_2.remove(0));
940 assert_eq!(payment_event.msgs.len(), 1);
947 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>) {
948 let mut events = origin_node.node.get_and_clear_pending_msg_events();
949 assert_eq!(events.len(), expected_route.len());
950 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
951 // Once we've gotten through all the HTLCs, the last one should result in a
952 // PaymentReceived (but each previous one should not!), .
953 let expect_payment = path_idx == expected_route.len() - 1;
954 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
958 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) {
959 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
962 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) {
963 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
964 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
965 (our_payment_preimage, our_payment_hash)
968 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) {
969 for path in expected_paths.iter() {
970 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
972 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
973 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
975 macro_rules! msgs_from_ev {
978 &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 } } => {
979 assert!(update_add_htlcs.is_empty());
980 assert_eq!(update_fulfill_htlcs.len(), 1);
981 assert!(update_fail_htlcs.is_empty());
982 assert!(update_fail_malformed_htlcs.is_empty());
983 assert!(update_fee.is_none());
984 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
986 _ => panic!("Unexpected event"),
990 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
991 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
992 assert_eq!(events.len(), expected_paths.len());
993 for ev in events.iter() {
994 per_path_msgs.push(msgs_from_ev!(ev));
997 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
998 let mut next_msgs = Some(path_msgs);
999 let mut expected_next_node = next_hop;
1001 macro_rules! last_update_fulfill_dance {
1002 ($node: expr, $prev_node: expr) => {
1004 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1005 check_added_monitors!($node, 0);
1006 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1007 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1011 macro_rules! mid_update_fulfill_dance {
1012 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1014 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1015 check_added_monitors!($node, 1);
1016 let new_next_msgs = if $new_msgs {
1017 let events = $node.node.get_and_clear_pending_msg_events();
1018 assert_eq!(events.len(), 1);
1019 let (res, nexthop) = msgs_from_ev!(&events[0]);
1020 expected_next_node = nexthop;
1023 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1026 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1027 next_msgs = new_next_msgs;
1032 let mut prev_node = expected_route.last().unwrap();
1033 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1034 assert_eq!(expected_next_node, node.node.get_our_node_id());
1035 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1036 if next_msgs.is_some() {
1037 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1039 assert!(!update_next_msgs);
1040 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1042 if !skip_last && idx == expected_route.len() - 1 {
1043 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1050 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1051 expect_payment_sent!(origin_node, our_payment_preimage);
1056 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) {
1057 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1060 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) {
1061 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1064 pub const TEST_FINAL_CLTV: u32 = 50;
1066 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1067 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1068 let logger = test_utils::TestLogger::new();
1069 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();
1070 assert_eq!(route.paths.len(), 1);
1071 assert_eq!(route.paths[0].len(), expected_route.len());
1072 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1073 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1076 send_along_route(origin_node, route, expected_route, recv_value)
1079 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1080 let logger = test_utils::TestLogger::new();
1081 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1082 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();
1083 assert_eq!(route.paths.len(), 1);
1084 assert_eq!(route.paths[0].len(), expected_route.len());
1085 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1086 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1089 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1090 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1091 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1094 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
1095 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1096 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1099 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) {
1100 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1101 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1102 check_added_monitors!(expected_route.last().unwrap(), 1);
1104 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1105 macro_rules! update_fail_dance {
1106 ($node: expr, $prev_node: expr, $last_node: expr) => {
1108 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1109 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1110 if skip_last && $last_node {
1111 expect_pending_htlcs_forwardable!($node);
1117 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1118 let mut prev_node = expected_route.last().unwrap();
1119 for (idx, node) in expected_route.iter().rev().enumerate() {
1120 assert_eq!(expected_next_node, node.node.get_our_node_id());
1121 if next_msgs.is_some() {
1122 // We may be the "last node" for the purpose of the commitment dance if we're
1123 // skipping the last node (implying it is disconnected) and we're the
1124 // second-to-last node!
1125 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1128 let events = node.node.get_and_clear_pending_msg_events();
1129 if !skip_last || idx != expected_route.len() - 1 {
1130 assert_eq!(events.len(), 1);
1132 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 } } => {
1133 assert!(update_add_htlcs.is_empty());
1134 assert!(update_fulfill_htlcs.is_empty());
1135 assert_eq!(update_fail_htlcs.len(), 1);
1136 assert!(update_fail_malformed_htlcs.is_empty());
1137 assert!(update_fee.is_none());
1138 expected_next_node = node_id.clone();
1139 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1141 _ => panic!("Unexpected event"),
1144 assert!(events.is_empty());
1146 if !skip_last && idx == expected_route.len() - 1 {
1147 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1154 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1156 let events = origin_node.node.get_and_clear_pending_events();
1157 assert_eq!(events.len(), 1);
1159 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1160 assert_eq!(payment_hash, our_payment_hash);
1161 assert!(rejected_by_dest);
1163 _ => panic!("Unexpected event"),
1168 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1169 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1172 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1173 let mut chan_mon_cfgs = Vec::new();
1174 for i in 0..node_count {
1175 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1176 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1177 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1178 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1179 let persister = test_utils::TestPersister::new();
1180 let seed = [i as u8; 32];
1181 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1183 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1189 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1190 let mut nodes = Vec::new();
1192 for i in 0..node_count {
1193 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);
1194 let seed = [i as u8; 32];
1195 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 });
1201 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>> {
1202 let mut chanmgrs = Vec::new();
1203 for i in 0..node_count {
1204 let mut default_config = UserConfig::default();
1205 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1206 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1207 default_config.channel_options.cltv_expiry_delta = 6*6;
1208 default_config.channel_options.announced_channel = true;
1209 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1210 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
1211 let network = Network::Testnet;
1212 let params = ChainParameters {
1214 latest_hash: genesis_block(network).header.block_hash(),
1217 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);
1218 chanmgrs.push(node);
1224 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>> {
1225 let mut nodes = Vec::new();
1226 let chan_count = Rc::new(RefCell::new(0));
1227 let payment_count = Rc::new(RefCell::new(0));
1229 for i in 0..node_count {
1230 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1231 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1232 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1233 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1234 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1235 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1236 blocks: RefCell::new(vec![(genesis_block(Network::Testnet).header, 0)])
1243 // Note that the following only works for CLTV values up to 128
1244 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1245 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1247 #[derive(PartialEq)]
1248 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1249 /// Tests that the given node has broadcast transactions for the given Channel
1251 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1252 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1253 /// broadcast and the revoked outputs were claimed.
1255 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1256 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1258 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1260 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> {
1261 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1262 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1264 let mut res = Vec::with_capacity(2);
1265 node_txn.retain(|tx| {
1266 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1267 check_spends!(tx, chan.3);
1268 if commitment_tx.is_none() {
1269 res.push(tx.clone());
1274 if let Some(explicit_tx) = commitment_tx {
1275 res.push(explicit_tx.clone());
1278 assert_eq!(res.len(), 1);
1280 if has_htlc_tx != HTLCType::NONE {
1281 node_txn.retain(|tx| {
1282 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1283 check_spends!(tx, res[0]);
1284 if has_htlc_tx == HTLCType::TIMEOUT {
1285 assert!(tx.lock_time != 0);
1287 assert!(tx.lock_time == 0);
1289 res.push(tx.clone());
1293 assert!(res.len() == 2 || res.len() == 3);
1295 assert_eq!(res[1], res[2]);
1299 assert!(node_txn.is_empty());
1303 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1304 /// HTLC transaction.
1305 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1306 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1307 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1308 // for revoked htlc outputs
1309 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1310 node_txn.retain(|tx| {
1311 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1312 check_spends!(tx, revoked_tx);
1316 node_txn.retain(|tx| {
1317 check_spends!(tx, commitment_revoked_tx);
1320 assert!(node_txn.is_empty());
1323 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1324 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1326 assert!(node_txn.len() >= 1);
1327 assert_eq!(node_txn[0].input.len(), 1);
1328 let mut found_prev = false;
1330 for tx in prev_txn {
1331 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1332 check_spends!(node_txn[0], tx);
1333 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1334 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1340 assert!(found_prev);
1342 let mut res = Vec::new();
1343 mem::swap(&mut *node_txn, &mut res);
1347 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1348 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1349 assert_eq!(events_1.len(), 1);
1350 let as_update = match events_1[0] {
1351 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1354 _ => panic!("Unexpected event"),
1357 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1358 assert_eq!(events_2.len(), 1);
1359 let bs_update = match events_2[0] {
1360 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1363 _ => panic!("Unexpected event"),
1367 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1368 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1373 macro_rules! get_channel_value_stat {
1374 ($node: expr, $channel_id: expr) => {{
1375 let chan_lock = $node.node.channel_state.lock().unwrap();
1376 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1377 chan.get_value_stat()
1381 macro_rules! get_chan_reestablish_msgs {
1382 ($src_node: expr, $dst_node: expr) => {
1384 let mut res = Vec::with_capacity(1);
1385 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1386 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1387 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1388 res.push(msg.clone());
1390 panic!("Unexpected event")
1398 macro_rules! handle_chan_reestablish_msgs {
1399 ($src_node: expr, $dst_node: expr) => {
1401 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1403 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1405 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1411 let mut revoke_and_ack = None;
1412 let mut commitment_update = None;
1413 let order = if let Some(ev) = msg_events.get(idx) {
1416 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1417 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1418 revoke_and_ack = Some(msg.clone());
1419 RAACommitmentOrder::RevokeAndACKFirst
1421 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1422 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1423 commitment_update = Some(updates.clone());
1424 RAACommitmentOrder::CommitmentFirst
1426 _ => panic!("Unexpected event"),
1429 RAACommitmentOrder::CommitmentFirst
1432 if let Some(ev) = msg_events.get(idx) {
1434 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1435 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1436 assert!(revoke_and_ack.is_none());
1437 revoke_and_ack = Some(msg.clone());
1439 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1440 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1441 assert!(commitment_update.is_none());
1442 commitment_update = Some(updates.clone());
1444 _ => panic!("Unexpected event"),
1448 (funding_locked, revoke_and_ack, commitment_update, order)
1453 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1454 /// for claims/fails they are separated out.
1455 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)) {
1456 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1457 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1458 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1459 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1461 if send_funding_locked.0 {
1462 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1464 for reestablish in reestablish_1.iter() {
1465 assert_eq!(reestablish.next_remote_commitment_number, 0);
1468 if send_funding_locked.1 {
1469 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1471 for reestablish in reestablish_2.iter() {
1472 assert_eq!(reestablish.next_remote_commitment_number, 0);
1475 if send_funding_locked.0 || send_funding_locked.1 {
1476 // If we expect any funding_locked's, both sides better have set
1477 // next_holder_commitment_number to 1
1478 for reestablish in reestablish_1.iter() {
1479 assert_eq!(reestablish.next_local_commitment_number, 1);
1481 for reestablish in reestablish_2.iter() {
1482 assert_eq!(reestablish.next_local_commitment_number, 1);
1486 let mut resp_1 = Vec::new();
1487 for msg in reestablish_1 {
1488 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1489 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1491 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1492 check_added_monitors!(node_b, 1);
1494 check_added_monitors!(node_b, 0);
1497 let mut resp_2 = Vec::new();
1498 for msg in reestablish_2 {
1499 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1500 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1502 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1503 check_added_monitors!(node_a, 1);
1505 check_added_monitors!(node_a, 0);
1508 // We don't yet support both needing updates, as that would require a different commitment dance:
1509 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1510 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1512 for chan_msgs in resp_1.drain(..) {
1513 if send_funding_locked.0 {
1514 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1515 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1516 if !announcement_event.is_empty() {
1517 assert_eq!(announcement_event.len(), 1);
1518 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1519 //TODO: Test announcement_sigs re-sending
1520 } else { panic!("Unexpected event!"); }
1523 assert!(chan_msgs.0.is_none());
1526 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1527 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1528 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1529 check_added_monitors!(node_a, 1);
1531 assert!(chan_msgs.1.is_none());
1533 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1534 let commitment_update = chan_msgs.2.unwrap();
1535 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1536 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1538 assert!(commitment_update.update_add_htlcs.is_empty());
1540 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1541 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1542 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1543 for update_add in commitment_update.update_add_htlcs {
1544 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1546 for update_fulfill in commitment_update.update_fulfill_htlcs {
1547 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1549 for update_fail in commitment_update.update_fail_htlcs {
1550 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1553 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1554 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1556 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1557 check_added_monitors!(node_a, 1);
1558 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1559 // No commitment_signed so get_event_msg's assert(len == 1) passes
1560 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1561 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1562 check_added_monitors!(node_b, 1);
1565 assert!(chan_msgs.2.is_none());
1569 for chan_msgs in resp_2.drain(..) {
1570 if send_funding_locked.1 {
1571 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1572 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1573 if !announcement_event.is_empty() {
1574 assert_eq!(announcement_event.len(), 1);
1575 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1576 //TODO: Test announcement_sigs re-sending
1577 } else { panic!("Unexpected event!"); }
1580 assert!(chan_msgs.0.is_none());
1583 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1584 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1585 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1586 check_added_monitors!(node_b, 1);
1588 assert!(chan_msgs.1.is_none());
1590 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1591 let commitment_update = chan_msgs.2.unwrap();
1592 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1593 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1595 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1596 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1597 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1598 for update_add in commitment_update.update_add_htlcs {
1599 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1601 for update_fulfill in commitment_update.update_fulfill_htlcs {
1602 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1604 for update_fail in commitment_update.update_fail_htlcs {
1605 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1608 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1609 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1611 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1612 check_added_monitors!(node_b, 1);
1613 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1614 // No commitment_signed so get_event_msg's assert(len == 1) passes
1615 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1616 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1617 check_added_monitors!(node_a, 1);
1620 assert!(chan_msgs.2.is_none());