1 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
2 //! nodes for functional tests.
4 use chain::chaininterface;
5 use chain::transaction::OutPoint;
6 use chain::keysinterface::KeysInterface;
7 use ln::channelmanager::{ChannelManager,RAACommitmentOrder, PaymentPreimage, PaymentHash};
8 use ln::router::{Route, Router};
10 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler, LocalFeatures};
11 use util::enforcing_trait_impls::EnforcingChannelKeys;
13 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
14 use util::errors::APIError;
15 use util::logger::Logger;
16 use util::config::UserConfig;
18 use bitcoin::util::hash::BitcoinHash;
19 use bitcoin::blockdata::block::BlockHeader;
20 use bitcoin::blockdata::transaction::{Transaction, TxOut};
21 use bitcoin::network::constants::Network;
23 use bitcoin_hashes::sha256::Hash as Sha256;
24 use bitcoin_hashes::sha256d::Hash as Sha256d;
25 use bitcoin_hashes::Hash;
27 use secp256k1::Secp256k1;
28 use secp256k1::key::PublicKey;
30 use rand::{thread_rng,Rng};
32 use std::cell::RefCell;
34 use std::sync::{Arc, Mutex};
37 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
38 pub fn confirm_transaction(notifier: &chaininterface::BlockNotifier, chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
39 assert!(chain.does_match_tx(tx));
40 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
41 notifier.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
42 for i in 2..CHAN_CONFIRM_DEPTH {
43 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
44 notifier.block_connected_checked(&header, i, &vec![], &[0; 0]);
48 pub fn connect_blocks(notifier: &chaininterface::BlockNotifier, depth: u32, height: u32, parent: bool, prev_blockhash: Sha256d) -> Sha256d {
49 let mut header = BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
50 notifier.block_connected_checked(&header, height + 1, &Vec::new(), &Vec::new());
51 for i in 2..depth + 1 {
52 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
53 notifier.block_connected_checked(&header, height + i, &Vec::new(), &Vec::new());
58 pub struct Node<'a, 'b: 'a> {
59 pub block_notifier: Arc<chaininterface::BlockNotifier<'a>>,
60 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
61 pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
62 pub chan_monitor: Arc<test_utils::TestChannelMonitor>,
63 pub keys_manager: Arc<test_utils::TestKeysInterface>,
64 pub node: Arc<ChannelManager<'b, EnforcingChannelKeys>>,
66 pub node_seed: [u8; 32],
67 pub network_payment_count: Rc<RefCell<u8>>,
68 pub network_chan_count: Rc<RefCell<u32>>,
70 impl<'a, 'b> Drop for Node<'a, 'b> {
72 if !::std::thread::panicking() {
73 // Check that we processed all pending events
74 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
75 assert!(self.node.get_and_clear_pending_events().is_empty());
76 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
81 pub fn create_chan_between_nodes(node_a: &Node, node_b: &Node, a_flags: LocalFeatures, b_flags: LocalFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
82 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
85 pub fn create_chan_between_nodes_with_value(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64, a_flags: LocalFeatures, b_flags: LocalFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
86 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);
87 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
88 (announcement, as_update, bs_update, channel_id, tx)
91 macro_rules! get_revoke_commit_msgs {
92 ($node: expr, $node_id: expr) => {
94 let events = $node.node.get_and_clear_pending_msg_events();
95 assert_eq!(events.len(), 2);
97 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
98 assert_eq!(*node_id, $node_id);
101 _ => panic!("Unexpected event"),
103 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
104 assert_eq!(*node_id, $node_id);
105 assert!(updates.update_add_htlcs.is_empty());
106 assert!(updates.update_fulfill_htlcs.is_empty());
107 assert!(updates.update_fail_htlcs.is_empty());
108 assert!(updates.update_fail_malformed_htlcs.is_empty());
109 assert!(updates.update_fee.is_none());
110 updates.commitment_signed.clone()
112 _ => panic!("Unexpected event"),
118 macro_rules! get_event_msg {
119 ($node: expr, $event_type: path, $node_id: expr) => {
121 let events = $node.node.get_and_clear_pending_msg_events();
122 assert_eq!(events.len(), 1);
124 $event_type { ref node_id, ref msg } => {
125 assert_eq!(*node_id, $node_id);
128 _ => panic!("Unexpected event"),
134 macro_rules! get_htlc_update_msgs {
135 ($node: expr, $node_id: expr) => {
137 let events = $node.node.get_and_clear_pending_msg_events();
138 assert_eq!(events.len(), 1);
140 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
141 assert_eq!(*node_id, $node_id);
144 _ => panic!("Unexpected event"),
150 macro_rules! get_feerate {
151 ($node: expr, $channel_id: expr) => {
153 let chan_lock = $node.node.channel_state.lock().unwrap();
154 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
160 pub fn create_funding_transaction(node: &Node, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
161 let chan_id = *node.network_chan_count.borrow();
163 let events = node.node.get_and_clear_pending_events();
164 assert_eq!(events.len(), 1);
166 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
167 assert_eq!(*channel_value_satoshis, expected_chan_value);
168 assert_eq!(user_channel_id, expected_user_chan_id);
170 let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
171 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
173 let funding_outpoint = OutPoint::new(tx.txid(), 0);
174 (*temporary_channel_id, tx, funding_outpoint)
176 _ => panic!("Unexpected event"),
180 pub fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64, a_flags: LocalFeatures, b_flags: LocalFeatures) -> Transaction {
181 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
182 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())).unwrap();
183 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())).unwrap();
185 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
188 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
189 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
190 assert_eq!(added_monitors.len(), 1);
191 assert_eq!(added_monitors[0].0, funding_output);
192 added_monitors.clear();
195 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())).unwrap();
197 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
198 assert_eq!(added_monitors.len(), 1);
199 assert_eq!(added_monitors[0].0, funding_output);
200 added_monitors.clear();
203 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())).unwrap();
205 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
206 assert_eq!(added_monitors.len(), 1);
207 assert_eq!(added_monitors[0].0, funding_output);
208 added_monitors.clear();
211 let events_4 = node_a.node.get_and_clear_pending_events();
212 assert_eq!(events_4.len(), 1);
214 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
215 assert_eq!(user_channel_id, 42);
216 assert_eq!(*funding_txo, funding_output);
218 _ => panic!("Unexpected event"),
224 pub fn create_chan_between_nodes_with_value_confirm_first(node_recv: &Node, node_conf: &Node, tx: &Transaction) {
225 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
226 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())).unwrap();
229 pub fn create_chan_between_nodes_with_value_confirm_second(node_recv: &Node, node_conf: &Node) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
231 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
232 assert_eq!(events_6.len(), 2);
233 ((match events_6[0] {
234 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
235 channel_id = msg.channel_id.clone();
236 assert_eq!(*node_id, node_recv.node.get_our_node_id());
239 _ => panic!("Unexpected event"),
240 }, match events_6[1] {
241 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
242 assert_eq!(*node_id, node_recv.node.get_our_node_id());
245 _ => panic!("Unexpected event"),
249 pub fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
250 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
251 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
252 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
255 pub fn create_chan_between_nodes_with_value_a(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64, a_flags: LocalFeatures, b_flags: LocalFeatures) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
256 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
257 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
261 pub fn create_chan_between_nodes_with_value_b(node_a: &Node, node_b: &Node, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
262 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
263 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
264 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
266 let events_7 = node_b.node.get_and_clear_pending_msg_events();
267 assert_eq!(events_7.len(), 1);
268 let (announcement, bs_update) = match events_7[0] {
269 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
272 _ => panic!("Unexpected event"),
275 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
276 let events_8 = node_a.node.get_and_clear_pending_msg_events();
277 assert_eq!(events_8.len(), 1);
278 let as_update = match events_8[0] {
279 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
280 assert!(*announcement == *msg);
281 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
282 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
285 _ => panic!("Unexpected event"),
288 *node_a.network_chan_count.borrow_mut() += 1;
290 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
293 pub fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize, a_flags: LocalFeatures, b_flags: LocalFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
294 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
297 pub fn create_announced_chan_between_nodes_with_value(nodes: &Vec<Node>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: LocalFeatures, b_flags: LocalFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
298 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
300 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
301 node.router.handle_channel_update(&chan_announcement.1).unwrap();
302 node.router.handle_channel_update(&chan_announcement.2).unwrap();
304 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
307 macro_rules! check_spends {
308 ($tx: expr, $spends_tx: expr) => {
310 $tx.verify(|out_point| {
311 if out_point.txid == $spends_tx.txid() {
312 $spends_tx.output.get(out_point.vout as usize).cloned()
321 macro_rules! get_closing_signed_broadcast {
322 ($node: expr, $dest_pubkey: expr) => {
324 let events = $node.get_and_clear_pending_msg_events();
325 assert!(events.len() == 1 || events.len() == 2);
326 (match events[events.len() - 1] {
327 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
328 assert_eq!(msg.contents.flags & 2, 2);
331 _ => panic!("Unexpected event"),
332 }, if events.len() == 2 {
334 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
335 assert_eq!(*node_id, $dest_pubkey);
338 _ => panic!("Unexpected event"),
345 macro_rules! check_closed_broadcast {
347 let events = $node.node.get_and_clear_pending_msg_events();
348 assert_eq!(events.len(), 1);
350 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
351 assert_eq!(msg.contents.flags & 2, 2);
353 _ => panic!("Unexpected event"),
358 pub fn close_channel<'a, 'b>(outbound_node: &Node<'a, 'b>, inbound_node: &Node<'a, 'b>, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
359 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) };
360 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
363 node_a.close_channel(channel_id).unwrap();
364 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
366 let events_1 = node_b.get_and_clear_pending_msg_events();
367 assert!(events_1.len() >= 1);
368 let shutdown_b = match events_1[0] {
369 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
370 assert_eq!(node_id, &node_a.get_our_node_id());
373 _ => panic!("Unexpected event"),
376 let closing_signed_b = if !close_inbound_first {
377 assert_eq!(events_1.len(), 1);
380 Some(match events_1[1] {
381 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
382 assert_eq!(node_id, &node_a.get_our_node_id());
385 _ => panic!("Unexpected event"),
389 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
390 let (as_update, bs_update) = if close_inbound_first {
391 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
392 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
393 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
394 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
395 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
397 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
398 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
399 assert!(none_b.is_none());
400 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
401 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
402 (as_update, bs_update)
404 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
406 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
407 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
408 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
409 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
411 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
412 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
413 assert!(none_a.is_none());
414 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
415 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
416 (as_update, bs_update)
418 assert_eq!(tx_a, tx_b);
419 check_spends!(tx_a, funding_tx);
421 (as_update, bs_update, tx_a)
424 pub struct SendEvent {
425 pub node_id: PublicKey,
426 pub msgs: Vec<msgs::UpdateAddHTLC>,
427 pub commitment_msg: msgs::CommitmentSigned,
430 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
431 assert!(updates.update_fulfill_htlcs.is_empty());
432 assert!(updates.update_fail_htlcs.is_empty());
433 assert!(updates.update_fail_malformed_htlcs.is_empty());
434 assert!(updates.update_fee.is_none());
435 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
438 pub fn from_event(event: MessageSendEvent) -> SendEvent {
440 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
441 _ => panic!("Unexpected event type!"),
445 pub fn from_node(node: &Node) -> SendEvent {
446 let mut events = node.node.get_and_clear_pending_msg_events();
447 assert_eq!(events.len(), 1);
448 SendEvent::from_event(events.pop().unwrap())
452 macro_rules! check_added_monitors {
453 ($node: expr, $count: expr) => {
455 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
456 assert_eq!(added_monitors.len(), $count);
457 added_monitors.clear();
462 macro_rules! commitment_signed_dance {
463 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
465 check_added_monitors!($node_a, 0);
466 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
467 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
468 check_added_monitors!($node_a, 1);
469 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
472 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
474 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
475 check_added_monitors!($node_b, 0);
476 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
477 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
478 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
479 check_added_monitors!($node_b, 1);
480 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
481 let (bs_revoke_and_ack, extra_msg_option) = {
482 let events = $node_b.node.get_and_clear_pending_msg_events();
483 assert!(events.len() <= 2);
485 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
486 assert_eq!(*node_id, $node_a.node.get_our_node_id());
489 _ => panic!("Unexpected event"),
490 }, events.get(1).map(|e| e.clone()))
492 check_added_monitors!($node_b, 1);
494 assert!($node_a.node.get_and_clear_pending_events().is_empty());
495 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
497 (extra_msg_option, bs_revoke_and_ack)
500 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
502 check_added_monitors!($node_a, 0);
503 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
504 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
505 check_added_monitors!($node_a, 1);
506 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
507 assert!(extra_msg_option.is_none());
511 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
513 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
514 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
515 check_added_monitors!($node_a, 1);
519 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
521 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
524 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
526 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
528 expect_pending_htlcs_forwardable!($node_a);
529 check_added_monitors!($node_a, 1);
531 let channel_state = $node_a.node.channel_state.lock().unwrap();
532 assert_eq!(channel_state.pending_msg_events.len(), 1);
533 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
534 assert_ne!(*node_id, $node_b.node.get_our_node_id());
535 } else { panic!("Unexpected event"); }
537 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
543 macro_rules! get_payment_preimage_hash {
546 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
547 *$node.network_payment_count.borrow_mut() += 1;
548 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
549 (payment_preimage, payment_hash)
554 macro_rules! expect_pending_htlcs_forwardable {
556 let events = $node.node.get_and_clear_pending_events();
557 assert_eq!(events.len(), 1);
559 Event::PendingHTLCsForwardable { .. } => { },
560 _ => panic!("Unexpected event"),
562 $node.node.process_pending_htlc_forwards();
566 macro_rules! expect_payment_received {
567 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
568 let events = $node.node.get_and_clear_pending_events();
569 assert_eq!(events.len(), 1);
571 Event::PaymentReceived { ref payment_hash, amt } => {
572 assert_eq!($expected_payment_hash, *payment_hash);
573 assert_eq!($expected_recv_value, amt);
575 _ => panic!("Unexpected event"),
580 macro_rules! expect_payment_sent {
581 ($node: expr, $expected_payment_preimage: expr) => {
582 let events = $node.node.get_and_clear_pending_events();
583 assert_eq!(events.len(), 1);
585 Event::PaymentSent { ref payment_preimage } => {
586 assert_eq!($expected_payment_preimage, *payment_preimage);
588 _ => panic!("Unexpected event"),
593 pub fn send_along_route_with_hash<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64, our_payment_hash: PaymentHash) {
594 let mut payment_event = {
595 origin_node.node.send_payment(route, our_payment_hash).unwrap();
596 check_added_monitors!(origin_node, 1);
598 let mut events = origin_node.node.get_and_clear_pending_msg_events();
599 assert_eq!(events.len(), 1);
600 SendEvent::from_event(events.remove(0))
602 let mut prev_node = origin_node;
604 for (idx, &node) in expected_route.iter().enumerate() {
605 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
607 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
608 check_added_monitors!(node, 0);
609 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
611 expect_pending_htlcs_forwardable!(node);
613 if idx == expected_route.len() - 1 {
614 let events_2 = node.node.get_and_clear_pending_events();
615 assert_eq!(events_2.len(), 1);
617 Event::PaymentReceived { ref payment_hash, amt } => {
618 assert_eq!(our_payment_hash, *payment_hash);
619 assert_eq!(amt, recv_value);
621 _ => panic!("Unexpected event"),
624 let mut events_2 = node.node.get_and_clear_pending_msg_events();
625 assert_eq!(events_2.len(), 1);
626 check_added_monitors!(node, 1);
627 payment_event = SendEvent::from_event(events_2.remove(0));
628 assert_eq!(payment_event.msgs.len(), 1);
635 pub fn send_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
636 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
637 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
638 (our_payment_preimage, our_payment_hash)
641 pub fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
642 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
643 check_added_monitors!(expected_route.last().unwrap(), 1);
645 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
646 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
647 macro_rules! get_next_msgs {
650 let events = $node.node.get_and_clear_pending_msg_events();
651 assert_eq!(events.len(), 1);
653 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 } } => {
654 assert!(update_add_htlcs.is_empty());
655 assert_eq!(update_fulfill_htlcs.len(), 1);
656 assert!(update_fail_htlcs.is_empty());
657 assert!(update_fail_malformed_htlcs.is_empty());
658 assert!(update_fee.is_none());
659 expected_next_node = node_id.clone();
660 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
662 _ => panic!("Unexpected event"),
668 macro_rules! last_update_fulfill_dance {
669 ($node: expr, $prev_node: expr) => {
671 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
672 check_added_monitors!($node, 0);
673 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
674 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
678 macro_rules! mid_update_fulfill_dance {
679 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
681 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
682 check_added_monitors!($node, 1);
683 let new_next_msgs = if $new_msgs {
684 get_next_msgs!($node)
686 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
689 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
690 next_msgs = new_next_msgs;
695 let mut prev_node = expected_route.last().unwrap();
696 for (idx, node) in expected_route.iter().rev().enumerate() {
697 assert_eq!(expected_next_node, node.node.get_our_node_id());
698 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
699 if next_msgs.is_some() {
700 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
701 } else if update_next_msgs {
702 next_msgs = get_next_msgs!(node);
704 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
706 if !skip_last && idx == expected_route.len() - 1 {
707 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
714 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
715 expect_payment_sent!(origin_node, our_payment_preimage);
719 pub fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
720 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
723 pub const TEST_FINAL_CLTV: u32 = 32;
725 pub fn route_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
726 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
727 assert_eq!(route.hops.len(), expected_route.len());
728 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
729 assert_eq!(hop.pubkey, node.node.get_our_node_id());
732 send_along_route(origin_node, route, expected_route, recv_value)
735 pub fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
736 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
737 assert_eq!(route.hops.len(), expected_route.len());
738 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
739 assert_eq!(hop.pubkey, node.node.get_our_node_id());
742 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
744 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
746 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
747 _ => panic!("Unknown error variants"),
751 pub fn send_payment<'a, 'b>(origin: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64, expected_value: u64) {
752 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
753 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
756 pub fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: PaymentHash) {
757 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
758 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
759 check_added_monitors!(expected_route.last().unwrap(), 1);
761 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
762 macro_rules! update_fail_dance {
763 ($node: expr, $prev_node: expr, $last_node: expr) => {
765 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
766 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
767 if skip_last && $last_node {
768 expect_pending_htlcs_forwardable!($node);
774 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
775 let mut prev_node = expected_route.last().unwrap();
776 for (idx, node) in expected_route.iter().rev().enumerate() {
777 assert_eq!(expected_next_node, node.node.get_our_node_id());
778 if next_msgs.is_some() {
779 // We may be the "last node" for the purpose of the commitment dance if we're
780 // skipping the last node (implying it is disconnected) and we're the
781 // second-to-last node!
782 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
785 let events = node.node.get_and_clear_pending_msg_events();
786 if !skip_last || idx != expected_route.len() - 1 {
787 assert_eq!(events.len(), 1);
789 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 } } => {
790 assert!(update_add_htlcs.is_empty());
791 assert!(update_fulfill_htlcs.is_empty());
792 assert_eq!(update_fail_htlcs.len(), 1);
793 assert!(update_fail_malformed_htlcs.is_empty());
794 assert!(update_fee.is_none());
795 expected_next_node = node_id.clone();
796 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
798 _ => panic!("Unexpected event"),
801 assert!(events.is_empty());
803 if !skip_last && idx == expected_route.len() - 1 {
804 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
811 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
813 let events = origin_node.node.get_and_clear_pending_events();
814 assert_eq!(events.len(), 1);
816 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
817 assert_eq!(payment_hash, our_payment_hash);
818 assert!(rejected_by_dest);
820 _ => panic!("Unexpected event"),
825 pub fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: PaymentHash) {
826 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
829 pub fn create_network(node_count: usize, node_config: &[Option<UserConfig>]) -> Vec<Node> {
830 let mut nodes = Vec::new();
831 let mut rng = thread_rng();
832 let secp_ctx = Secp256k1::new();
834 let chan_count = Rc::new(RefCell::new(0));
835 let payment_count = Rc::new(RefCell::new(0));
837 for i in 0..node_count {
838 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
839 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
840 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
841 let block_notifier = Arc::new(chaininterface::BlockNotifier::new(chain_monitor.clone()));
842 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
843 let mut seed = [0; 32];
844 rng.fill_bytes(&mut seed);
845 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, Arc::clone(&logger)));
846 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone()));
847 let weak_res = Arc::downgrade(&chan_monitor.simple_monitor);
848 block_notifier.register_listener(weak_res);
849 let mut default_config = UserConfig::default();
850 default_config.channel_options.announced_channel = true;
851 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
852 let node = ChannelManager::new(Network::Testnet, feeest.clone(), chan_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone(), if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0).unwrap();
853 let weak_res = Arc::downgrade(&node);
854 block_notifier.register_listener(weak_res);
855 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
856 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, keys_manager, node_seed: seed,
857 network_payment_count: payment_count.clone(),
858 network_chan_count: chan_count.clone(),
867 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
868 /// Tests that the given node has broadcast transactions for the given Channel
870 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
871 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
872 /// broadcast and the revoked outputs were claimed.
874 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
875 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
877 /// All broadcast transactions must be accounted for in one of the above three types of we'll
879 pub fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
880 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
881 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
883 let mut res = Vec::with_capacity(2);
884 node_txn.retain(|tx| {
885 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
886 check_spends!(tx, chan.3.clone());
887 if commitment_tx.is_none() {
888 res.push(tx.clone());
893 if let Some(explicit_tx) = commitment_tx {
894 res.push(explicit_tx.clone());
897 assert_eq!(res.len(), 1);
899 if has_htlc_tx != HTLCType::NONE {
900 node_txn.retain(|tx| {
901 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
902 check_spends!(tx, res[0].clone());
903 if has_htlc_tx == HTLCType::TIMEOUT {
904 assert!(tx.lock_time != 0);
906 assert!(tx.lock_time == 0);
908 res.push(tx.clone());
912 assert!(res.len() == 2 || res.len() == 3);
914 assert_eq!(res[1], res[2]);
918 assert!(node_txn.is_empty());
922 /// Tests that the given node has broadcast a claim transaction against the provided revoked
923 /// HTLC transaction.
924 pub fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
925 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
926 // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
927 // but sometimes not as feerate is too-low
928 if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
929 node_txn.retain(|tx| {
930 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
931 check_spends!(tx, revoked_tx);
935 node_txn.retain(|tx| {
936 check_spends!(tx, commitment_revoked_tx);
939 assert!(node_txn.is_empty());
942 pub fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
943 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
945 assert!(node_txn.len() >= 1);
946 assert_eq!(node_txn[0].input.len(), 1);
947 let mut found_prev = false;
950 if node_txn[0].input[0].previous_output.txid == tx.txid() {
951 check_spends!(node_txn[0], tx.clone());
952 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
953 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
961 let mut res = Vec::new();
962 mem::swap(&mut *node_txn, &mut res);
966 pub fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
967 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
968 assert_eq!(events_1.len(), 1);
969 let as_update = match events_1[0] {
970 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
973 _ => panic!("Unexpected event"),
976 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
977 assert_eq!(events_2.len(), 1);
978 let bs_update = match events_2[0] {
979 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
982 _ => panic!("Unexpected event"),
986 node.router.handle_channel_update(&as_update).unwrap();
987 node.router.handle_channel_update(&bs_update).unwrap();
991 macro_rules! get_channel_value_stat {
992 ($node: expr, $channel_id: expr) => {{
993 let chan_lock = $node.node.channel_state.lock().unwrap();
994 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
995 chan.get_value_stat()
999 macro_rules! get_chan_reestablish_msgs {
1000 ($src_node: expr, $dst_node: expr) => {
1002 let mut res = Vec::with_capacity(1);
1003 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1004 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1005 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1006 res.push(msg.clone());
1008 panic!("Unexpected event")
1016 macro_rules! handle_chan_reestablish_msgs {
1017 ($src_node: expr, $dst_node: expr) => {
1019 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1021 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1023 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1029 let mut revoke_and_ack = None;
1030 let mut commitment_update = None;
1031 let order = if let Some(ev) = msg_events.get(idx) {
1034 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1035 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1036 revoke_and_ack = Some(msg.clone());
1037 RAACommitmentOrder::RevokeAndACKFirst
1039 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1040 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1041 commitment_update = Some(updates.clone());
1042 RAACommitmentOrder::CommitmentFirst
1044 _ => panic!("Unexpected event"),
1047 RAACommitmentOrder::CommitmentFirst
1050 if let Some(ev) = msg_events.get(idx) {
1052 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1053 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1054 assert!(revoke_and_ack.is_none());
1055 revoke_and_ack = Some(msg.clone());
1057 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1058 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1059 assert!(commitment_update.is_none());
1060 commitment_update = Some(updates.clone());
1062 _ => panic!("Unexpected event"),
1066 (funding_locked, revoke_and_ack, commitment_update, order)
1071 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1072 /// for claims/fails they are separated out.
1073 pub fn reconnect_nodes(node_a: &Node, node_b: &Node, 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)) {
1074 node_a.node.peer_connected(&node_b.node.get_our_node_id());
1075 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1076 node_b.node.peer_connected(&node_a.node.get_our_node_id());
1077 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1079 if send_funding_locked.0 {
1080 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1082 for reestablish in reestablish_1.iter() {
1083 assert_eq!(reestablish.next_remote_commitment_number, 0);
1086 if send_funding_locked.1 {
1087 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1089 for reestablish in reestablish_2.iter() {
1090 assert_eq!(reestablish.next_remote_commitment_number, 0);
1093 if send_funding_locked.0 || send_funding_locked.1 {
1094 // If we expect any funding_locked's, both sides better have set
1095 // next_local_commitment_number to 1
1096 for reestablish in reestablish_1.iter() {
1097 assert_eq!(reestablish.next_local_commitment_number, 1);
1099 for reestablish in reestablish_2.iter() {
1100 assert_eq!(reestablish.next_local_commitment_number, 1);
1104 let mut resp_1 = Vec::new();
1105 for msg in reestablish_1 {
1106 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
1107 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1109 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1110 check_added_monitors!(node_b, 1);
1112 check_added_monitors!(node_b, 0);
1115 let mut resp_2 = Vec::new();
1116 for msg in reestablish_2 {
1117 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
1118 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1120 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1121 check_added_monitors!(node_a, 1);
1123 check_added_monitors!(node_a, 0);
1126 // We don't yet support both needing updates, as that would require a different commitment dance:
1127 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1128 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1130 for chan_msgs in resp_1.drain(..) {
1131 if send_funding_locked.0 {
1132 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
1133 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1134 if !announcement_event.is_empty() {
1135 assert_eq!(announcement_event.len(), 1);
1136 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1137 //TODO: Test announcement_sigs re-sending
1138 } else { panic!("Unexpected event!"); }
1141 assert!(chan_msgs.0.is_none());
1144 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1145 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
1146 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1147 check_added_monitors!(node_a, 1);
1149 assert!(chan_msgs.1.is_none());
1151 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1152 let commitment_update = chan_msgs.2.unwrap();
1153 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1154 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1156 assert!(commitment_update.update_add_htlcs.is_empty());
1158 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1159 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1160 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1161 for update_add in commitment_update.update_add_htlcs {
1162 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
1164 for update_fulfill in commitment_update.update_fulfill_htlcs {
1165 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
1167 for update_fail in commitment_update.update_fail_htlcs {
1168 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
1171 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1172 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1174 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
1175 check_added_monitors!(node_a, 1);
1176 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1177 // No commitment_signed so get_event_msg's assert(len == 1) passes
1178 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
1179 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1180 check_added_monitors!(node_b, 1);
1183 assert!(chan_msgs.2.is_none());
1187 for chan_msgs in resp_2.drain(..) {
1188 if send_funding_locked.1 {
1189 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
1190 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1191 if !announcement_event.is_empty() {
1192 assert_eq!(announcement_event.len(), 1);
1193 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1194 //TODO: Test announcement_sigs re-sending
1195 } else { panic!("Unexpected event!"); }
1198 assert!(chan_msgs.0.is_none());
1201 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1202 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
1203 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1204 check_added_monitors!(node_b, 1);
1206 assert!(chan_msgs.1.is_none());
1208 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1209 let commitment_update = chan_msgs.2.unwrap();
1210 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1211 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1213 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1214 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1215 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1216 for update_add in commitment_update.update_add_htlcs {
1217 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
1219 for update_fulfill in commitment_update.update_fulfill_htlcs {
1220 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
1222 for update_fail in commitment_update.update_fail_htlcs {
1223 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
1226 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1227 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1229 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
1230 check_added_monitors!(node_b, 1);
1231 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1232 // No commitment_signed so get_event_msg's assert(len == 1) passes
1233 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1234 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1235 check_added_monitors!(node_a, 1);
1238 assert!(chan_msgs.2.is_none());