Merge pull request #2810 from TheBlueMatt/2023-12-arbitrary-fuzz-config
[rust-lightning] / lightning / src / ln / functional_test_utils.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
12
13 use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, chainmonitor::Persist};
14 use crate::chain::channelmonitor::ChannelMonitor;
15 use crate::chain::transaction::OutPoint;
16 use crate::events::{ClaimedHTLC, ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
17 use crate::events::bump_transaction::{BumpTransactionEvent, BumpTransactionEventHandler, Wallet, WalletSource};
18 use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
19 use crate::ln::channelmanager::{AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
20 use crate::ln::features::InitFeatures;
21 use crate::ln::msgs;
22 use crate::ln::msgs::{ChannelMessageHandler, OnionMessageHandler, RoutingMessageHandler};
23 use crate::ln::peer_handler::IgnoringMessageHandler;
24 use crate::onion_message::messenger::OnionMessenger;
25 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
26 use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
27 use crate::sign::{EntropySource, RandomBytes};
28 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
29 use crate::util::errors::APIError;
30 #[cfg(test)]
31 use crate::util::logger::Logger;
32 use crate::util::scid_utils;
33 use crate::util::test_channel_signer::TestChannelSigner;
34 use crate::util::test_utils;
35 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
36 use crate::util::ser::{ReadableArgs, Writeable};
37
38 use bitcoin::blockdata::block::{Block, Header, Version};
39 use bitcoin::blockdata::locktime::absolute::LockTime;
40 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut};
41 use bitcoin::hash_types::{BlockHash, TxMerkleNode};
42 use bitcoin::hashes::sha256::Hash as Sha256;
43 use bitcoin::hashes::Hash as _;
44 use bitcoin::network::constants::Network;
45 use bitcoin::pow::CompactTarget;
46 use bitcoin::secp256k1::{PublicKey, SecretKey};
47
48 use alloc::rc::Rc;
49 use core::cell::RefCell;
50 use core::iter::repeat;
51 use core::mem;
52 use core::ops::Deref;
53 use crate::io;
54 use crate::prelude::*;
55 use crate::sync::{Arc, Mutex, LockTestExt, RwLock};
56
57 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
58
59 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
60 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
61 ///
62 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
63 /// output is the 1st output in the transaction.
64 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
65         let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
66         connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
67         scid
68 }
69 /// Mine a single block containing the given transaction
70 ///
71 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
72 /// output is the 1st output in the transaction.
73 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
74         let height = node.best_block_info().1 + 1;
75         confirm_transaction_at(node, tx, height)
76 }
77 /// Mine a single block containing the given transactions
78 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
79         let height = node.best_block_info().1 + 1;
80         confirm_transactions_at(node, txn, height);
81 }
82 /// Mine a single block containing the given transaction without extra consistency checks which may
83 /// impact ChannelManager state.
84 pub fn mine_transaction_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
85         let height = node.best_block_info().1 + 1;
86         let mut block = Block {
87                 header: Header {
88                         version: Version::NO_SOFT_FORK_SIGNALLING,
89                         prev_blockhash: node.best_block_hash(),
90                         merkle_root: TxMerkleNode::all_zeros(),
91                         time: height,
92                         bits: CompactTarget::from_consensus(42),
93                         nonce: 42,
94                 },
95                 txdata: Vec::new(),
96         };
97         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
98                 block.txdata.push(Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
99         }
100         block.txdata.push((*tx).clone());
101         do_connect_block_without_consistency_checks(node, block, false);
102 }
103 /// Mine the given transaction at the given height, mining blocks as required to build to that
104 /// height
105 ///
106 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
107 /// output is the 1st output in the transaction.
108 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
109         let first_connect_height = node.best_block_info().1 + 1;
110         assert!(first_connect_height <= conf_height);
111         if conf_height > first_connect_height {
112                 connect_blocks(node, conf_height - first_connect_height);
113         }
114         let mut txdata = Vec::new();
115         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
116                 txdata.push(Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
117         }
118         for tx in txn {
119                 txdata.push((*tx).clone());
120         }
121         let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
122         connect_block(node, &block);
123         scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
124 }
125 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
126         confirm_transactions_at(node, &[tx], conf_height)
127 }
128
129 /// The possible ways we may notify a ChannelManager of a new block
130 #[derive(Clone, Copy, Debug, PartialEq)]
131 pub enum ConnectStyle {
132         /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
133         /// the header and height information.
134         BestBlockFirst,
135         /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
136         /// make a single `best_block_updated` call.
137         BestBlockFirstSkippingBlocks,
138         /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
139         /// `transaction_unconfirmed` is called.
140         BestBlockFirstReorgsOnlyTip,
141         /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
142         /// the header and height information.
143         TransactionsFirst,
144         /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
145         /// make a single `best_block_updated` call.
146         TransactionsFirstSkippingBlocks,
147         /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
148         /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
149         /// times to ensure it's idempotent.
150         TransactionsDuplicativelyFirstSkippingBlocks,
151         /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
152         /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
153         /// times to ensure it's idempotent.
154         HighlyRedundantTransactionsFirstSkippingBlocks,
155         /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
156         /// `transaction_unconfirmed` is called.
157         TransactionsFirstReorgsOnlyTip,
158         /// Provides the full block via the `chain::Listen` interface. In the current code this is
159         /// equivalent to `TransactionsFirst` with some additional assertions.
160         FullBlockViaListen,
161 }
162
163 impl ConnectStyle {
164         pub fn skips_blocks(&self) -> bool {
165                 match self {
166                         ConnectStyle::BestBlockFirst => false,
167                         ConnectStyle::BestBlockFirstSkippingBlocks => true,
168                         ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
169                         ConnectStyle::TransactionsFirst => false,
170                         ConnectStyle::TransactionsFirstSkippingBlocks => true,
171                         ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
172                         ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
173                         ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
174                         ConnectStyle::FullBlockViaListen => false,
175                 }
176         }
177
178         pub fn updates_best_block_first(&self) -> bool {
179                 match self {
180                         ConnectStyle::BestBlockFirst => true,
181                         ConnectStyle::BestBlockFirstSkippingBlocks => true,
182                         ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
183                         ConnectStyle::TransactionsFirst => false,
184                         ConnectStyle::TransactionsFirstSkippingBlocks => false,
185                         ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
186                         ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
187                         ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
188                         ConnectStyle::FullBlockViaListen => false,
189                 }
190         }
191
192         fn random_style() -> ConnectStyle {
193                 #[cfg(feature = "std")] {
194                         use core::hash::{BuildHasher, Hasher};
195                         // Get a random value using the only std API to do so - the DefaultHasher
196                         let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
197                         let res = match rand_val % 9 {
198                                 0 => ConnectStyle::BestBlockFirst,
199                                 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
200                                 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
201                                 3 => ConnectStyle::TransactionsFirst,
202                                 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
203                                 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
204                                 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
205                                 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
206                                 8 => ConnectStyle::FullBlockViaListen,
207                                 _ => unreachable!(),
208                         };
209                         eprintln!("Using Block Connection Style: {:?}", res);
210                         res
211                 }
212                 #[cfg(not(feature = "std"))] {
213                         ConnectStyle::FullBlockViaListen
214                 }
215         }
216 }
217
218 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> Header {
219         Header {
220                 version: Version::NO_SOFT_FORK_SIGNALLING,
221                 prev_blockhash,
222                 merkle_root: TxMerkleNode::all_zeros(),
223                 time,
224                 bits: CompactTarget::from_consensus(42),
225                 nonce: 42,
226         }
227 }
228
229 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
230         Block { header: create_dummy_header(prev_blockhash, time), txdata }
231 }
232
233 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
234         let skip_intermediaries = node.connect_style.borrow().skips_blocks();
235
236         let height = node.best_block_info().1 + 1;
237         let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
238         assert!(depth >= 1);
239         for i in 1..depth {
240                 let prev_blockhash = block.header.block_hash();
241                 do_connect_block_with_consistency_checks(node, block, skip_intermediaries);
242                 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
243         }
244         let hash = block.header.block_hash();
245         do_connect_block_with_consistency_checks(node, block, false);
246         hash
247 }
248
249 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
250         do_connect_block_with_consistency_checks(node, block.clone(), false);
251 }
252
253 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
254         // Ensure `get_claimable_balances`' self-tests never panic
255         for (funding_outpoint, _channel_id) in node.chain_monitor.chain_monitor.list_monitors() {
256                 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
257         }
258 }
259
260 fn do_connect_block_with_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
261         call_claimable_balances(node);
262         do_connect_block_without_consistency_checks(node, block, skip_intermediaries);
263         call_claimable_balances(node);
264         node.node.test_process_background_events();
265 }
266
267 fn do_connect_block_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
268         let height = node.best_block_info().1 + 1;
269         #[cfg(feature = "std")] {
270                 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
271         }
272         // Update the block internally before handing it over to LDK, to ensure our assertions regarding
273         // transaction broadcast are correct.
274         node.blocks.lock().unwrap().push((block.clone(), height));
275         if !skip_intermediaries {
276                 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
277                 match *node.connect_style.borrow() {
278                         ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
279                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
280                                 call_claimable_balances(node);
281                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
282                                 node.node.best_block_updated(&block.header, height);
283                                 node.node.transactions_confirmed(&block.header, &txdata, height);
284                         },
285                         ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
286                         ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
287                         ConnectStyle::TransactionsFirstReorgsOnlyTip => {
288                                 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
289                                         let mut connections = Vec::new();
290                                         for (block, height) in node.blocks.lock().unwrap().iter() {
291                                                 if !block.txdata.is_empty() {
292                                                         // Reconnect all transactions we've ever seen to ensure transaction connection
293                                                         // is *really* idempotent. This is a somewhat likely deployment for some
294                                                         // esplora implementations of chain sync which try to reduce state and
295                                                         // complexity as much as possible.
296                                                         //
297                                                         // Sadly we have to clone the block here to maintain lockorder. In the
298                                                         // future we should consider Arc'ing the blocks to avoid this.
299                                                         connections.push((block.clone(), *height));
300                                                 }
301                                         }
302                                         for (old_block, height) in connections {
303                                                 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
304                                                         &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
305                                         }
306                                 }
307                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
308                                 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
309                                         node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
310                                 }
311                                 call_claimable_balances(node);
312                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
313                                 node.node.transactions_confirmed(&block.header, &txdata, height);
314                                 node.node.best_block_updated(&block.header, height);
315                         },
316                         ConnectStyle::FullBlockViaListen => {
317                                 node.chain_monitor.chain_monitor.block_connected(&block, height);
318                                 node.node.block_connected(&block, height);
319                         }
320                 }
321         }
322
323         for tx in &block.txdata {
324                 for input in &tx.input {
325                         node.wallet_source.remove_utxo(input.previous_output);
326                 }
327                 let wallet_script = node.wallet_source.get_change_script().unwrap();
328                 for (idx, output) in tx.output.iter().enumerate() {
329                         if output.script_pubkey == wallet_script {
330                                 let outpoint = bitcoin::OutPoint { txid: tx.txid(), vout: idx as u32 };
331                                 node.wallet_source.add_utxo(outpoint, output.value);
332                         }
333                 }
334         }
335 }
336
337 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
338         call_claimable_balances(node);
339         #[cfg(feature = "std")] {
340                 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
341         }
342         for i in 0..count {
343                 let orig = node.blocks.lock().unwrap().pop().unwrap();
344                 assert!(orig.1 > 0); // Cannot disconnect genesis
345                 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
346
347                 match *node.connect_style.borrow() {
348                         ConnectStyle::FullBlockViaListen => {
349                                 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
350                                 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
351                         },
352                         ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
353                         ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
354                                 if i == count - 1 {
355                                         node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
356                                         node.node.best_block_updated(&prev.0.header, prev.1);
357                                 }
358                         },
359                         ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
360                                 for tx in orig.0.txdata {
361                                         node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
362                                         node.node.transaction_unconfirmed(&tx.txid());
363                                 }
364                         },
365                         _ => {
366                                 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
367                                 node.node.best_block_updated(&prev.0.header, prev.1);
368                         },
369                 }
370                 call_claimable_balances(node);
371         }
372 }
373
374 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
375         let count = node.blocks.lock().unwrap().len() as u32 - 1;
376         disconnect_blocks(node, count);
377 }
378
379 pub struct TestChanMonCfg {
380         pub tx_broadcaster: test_utils::TestBroadcaster,
381         pub fee_estimator: test_utils::TestFeeEstimator,
382         pub chain_source: test_utils::TestChainSource,
383         pub persister: test_utils::TestPersister,
384         pub logger: test_utils::TestLogger,
385         pub keys_manager: test_utils::TestKeysInterface,
386         pub scorer: RwLock<test_utils::TestScorer>,
387 }
388
389 pub struct NodeCfg<'a> {
390         pub chain_source: &'a test_utils::TestChainSource,
391         pub tx_broadcaster: &'a test_utils::TestBroadcaster,
392         pub fee_estimator: &'a test_utils::TestFeeEstimator,
393         pub router: test_utils::TestRouter<'a>,
394         pub message_router: test_utils::TestMessageRouter<'a>,
395         pub chain_monitor: test_utils::TestChainMonitor<'a>,
396         pub keys_manager: &'a test_utils::TestKeysInterface,
397         pub logger: &'a test_utils::TestLogger,
398         pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
399         pub node_seed: [u8; 32],
400         pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
401 }
402
403 type TestChannelManager<'node_cfg, 'chan_mon_cfg> = ChannelManager<
404         &'node_cfg TestChainMonitor<'chan_mon_cfg>,
405         &'chan_mon_cfg test_utils::TestBroadcaster,
406         &'node_cfg test_utils::TestKeysInterface,
407         &'node_cfg test_utils::TestKeysInterface,
408         &'node_cfg test_utils::TestKeysInterface,
409         &'chan_mon_cfg test_utils::TestFeeEstimator,
410         &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
411         &'chan_mon_cfg test_utils::TestLogger,
412 >;
413
414 type TestOnionMessenger<'chan_man, 'node_cfg, 'chan_mon_cfg> = OnionMessenger<
415         DedicatedEntropy,
416         &'node_cfg test_utils::TestKeysInterface,
417         &'chan_mon_cfg test_utils::TestLogger,
418         &'node_cfg test_utils::TestMessageRouter<'chan_mon_cfg>,
419         &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
420         IgnoringMessageHandler,
421 >;
422
423 /// For use with [`OnionMessenger`] otherwise `test_restored_packages_retry` will fail. This is
424 /// because that test uses older serialized data produced by calling [`EntropySource`] in a specific
425 /// manner. Using the same [`EntropySource`] with [`OnionMessenger`] would introduce another call,
426 /// causing the produced data to no longer match.
427 pub struct DedicatedEntropy(RandomBytes);
428
429 impl Deref for DedicatedEntropy {
430         type Target = RandomBytes;
431         fn deref(&self) -> &Self::Target { &self.0 }
432 }
433
434 pub struct Node<'chan_man, 'node_cfg: 'chan_man, 'chan_mon_cfg: 'node_cfg> {
435         pub chain_source: &'chan_mon_cfg test_utils::TestChainSource,
436         pub tx_broadcaster: &'chan_mon_cfg test_utils::TestBroadcaster,
437         pub fee_estimator: &'chan_mon_cfg test_utils::TestFeeEstimator,
438         pub router: &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
439         pub chain_monitor: &'node_cfg test_utils::TestChainMonitor<'chan_mon_cfg>,
440         pub keys_manager: &'chan_mon_cfg test_utils::TestKeysInterface,
441         pub node: &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
442         pub onion_messenger: TestOnionMessenger<'chan_man, 'node_cfg, 'chan_mon_cfg>,
443         pub network_graph: &'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>,
444         pub gossip_sync: P2PGossipSync<&'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>, &'chan_mon_cfg test_utils::TestChainSource, &'chan_mon_cfg test_utils::TestLogger>,
445         pub node_seed: [u8; 32],
446         pub network_payment_count: Rc<RefCell<u8>>,
447         pub network_chan_count: Rc<RefCell<u32>>,
448         pub logger: &'chan_mon_cfg test_utils::TestLogger,
449         pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
450         pub connect_style: Rc<RefCell<ConnectStyle>>,
451         pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
452         pub wallet_source: Arc<test_utils::TestWalletSource>,
453         pub bump_tx_handler: BumpTransactionEventHandler<
454                 &'chan_mon_cfg test_utils::TestBroadcaster,
455                 Arc<Wallet<Arc<test_utils::TestWalletSource>, &'chan_mon_cfg test_utils::TestLogger>>,
456                 &'chan_mon_cfg test_utils::TestKeysInterface,
457                 &'chan_mon_cfg test_utils::TestLogger,
458         >,
459 }
460
461 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
462         pub fn init_features(&self, peer_node_id: &PublicKey) -> InitFeatures {
463                 self.override_init_features.borrow().clone()
464                         .unwrap_or_else(|| self.node.init_features() | self.onion_messenger.provided_init_features(peer_node_id))
465         }
466 }
467
468 #[cfg(feature = "std")]
469 impl<'a, 'b, 'c> std::panic::UnwindSafe for Node<'a, 'b, 'c> {}
470 #[cfg(feature = "std")]
471 impl<'a, 'b, 'c> std::panic::RefUnwindSafe for Node<'a, 'b, 'c> {}
472 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
473         pub fn best_block_hash(&self) -> BlockHash {
474                 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
475         }
476         pub fn best_block_info(&self) -> (BlockHash, u32) {
477                 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
478         }
479         pub fn get_block_header(&self, height: u32) -> Header {
480                 self.blocks.lock().unwrap()[height as usize].0.header
481         }
482         /// Changes the channel signer's availability for the specified peer and channel.
483         ///
484         /// When `available` is set to `true`, the channel signer will behave normally. When set to
485         /// `false`, the channel signer will act like an off-line remote signer and will return `Err` for
486         /// several of the signing methods. Currently, only `get_per_commitment_point` and
487         /// `release_commitment_secret` are affected by this setting.
488         #[cfg(test)]
489         pub fn set_channel_signer_available(&self, peer_id: &PublicKey, chan_id: &ChannelId, available: bool) {
490                 let per_peer_state = self.node.per_peer_state.read().unwrap();
491                 let chan_lock = per_peer_state.get(peer_id).unwrap().lock().unwrap();
492                 let signer = (|| {
493                         match chan_lock.channel_by_id.get(chan_id) {
494                                 Some(phase) => phase.context().get_signer(),
495                                 None => panic!("Couldn't find a channel with id {}", chan_id),
496                         }
497                 })();
498                 log_debug!(self.logger, "Setting channel signer for {} as available={}", chan_id, available);
499                 signer.as_ecdsa().unwrap().set_available(available);
500         }
501 }
502
503 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
504 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
505 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
506 /// to figure out.
507 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
508 impl NodePtr {
509         pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
510                 Self((node as *const Node<'a, 'b, 'c>).cast())
511         }
512 }
513 unsafe impl Send for NodePtr {}
514 unsafe impl Sync for NodePtr {}
515
516
517 pub trait NodeHolder {
518         type CM: AChannelManager;
519         fn node(&self) -> &ChannelManager<
520                 <Self::CM as AChannelManager>::M,
521                 <Self::CM as AChannelManager>::T,
522                 <Self::CM as AChannelManager>::ES,
523                 <Self::CM as AChannelManager>::NS,
524                 <Self::CM as AChannelManager>::SP,
525                 <Self::CM as AChannelManager>::F,
526                 <Self::CM as AChannelManager>::R,
527                 <Self::CM as AChannelManager>::L>;
528         fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
529 }
530 impl<H: NodeHolder> NodeHolder for &H {
531         type CM = H::CM;
532         fn node(&self) -> &ChannelManager<
533                 <Self::CM as AChannelManager>::M,
534                 <Self::CM as AChannelManager>::T,
535                 <Self::CM as AChannelManager>::ES,
536                 <Self::CM as AChannelManager>::NS,
537                 <Self::CM as AChannelManager>::SP,
538                 <Self::CM as AChannelManager>::F,
539                 <Self::CM as AChannelManager>::R,
540                 <Self::CM as AChannelManager>::L> { (*self).node() }
541         fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
542 }
543 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
544         type CM = TestChannelManager<'b, 'c>;
545         fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
546         fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
547 }
548
549 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
550         fn drop(&mut self) {
551                 if !panicking() {
552                         // Check that we processed all pending events
553                         let msg_events = self.node.get_and_clear_pending_msg_events();
554                         if !msg_events.is_empty() {
555                                 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
556                         }
557                         let events = self.node.get_and_clear_pending_events();
558                         if !events.is_empty() {
559                                 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
560                         }
561                         let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
562                         if !added_monitors.is_empty() {
563                                 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
564                         }
565
566                         // Check that if we serialize the network graph, we can deserialize it again.
567                         let network_graph = {
568                                 let mut w = test_utils::TestVecWriter(Vec::new());
569                                 self.network_graph.write(&mut w).unwrap();
570                                 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
571                                 assert!(network_graph_deser == *self.network_graph);
572                                 let gossip_sync = P2PGossipSync::new(
573                                         &network_graph_deser, Some(self.chain_source), self.logger
574                                 );
575                                 let mut chan_progress = 0;
576                                 loop {
577                                         let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
578                                         let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
579                                         assert!(orig_announcements == deserialized_announcements);
580                                         chan_progress = match orig_announcements {
581                                                 Some(announcement) => announcement.0.contents.short_channel_id + 1,
582                                                 None => break,
583                                         };
584                                 }
585                                 let mut node_progress = None;
586                                 loop {
587                                         let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
588                                         let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
589                                         assert!(orig_announcements == deserialized_announcements);
590                                         node_progress = match orig_announcements {
591                                                 Some(announcement) => Some(announcement.contents.node_id),
592                                                 None => break,
593                                         };
594                                 }
595                                 network_graph_deser
596                         };
597
598                         // Check that if we serialize and then deserialize all our channel monitors we get the
599                         // same set of outputs to watch for on chain as we have now. Note that if we write
600                         // tests that fully close channels and remove the monitors at some point this may break.
601                         let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
602                         let mut deserialized_monitors = Vec::new();
603                         {
604                                 for (outpoint, _channel_id) in self.chain_monitor.chain_monitor.list_monitors() {
605                                         let mut w = test_utils::TestVecWriter(Vec::new());
606                                         self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
607                                         let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
608                                                 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
609                                         deserialized_monitors.push(deserialized_monitor);
610                                 }
611                         }
612
613                         let broadcaster = test_utils::TestBroadcaster {
614                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
615                                 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
616                         };
617
618                         // Before using all the new monitors to check the watch outpoints, use the full set of
619                         // them to ensure we can write and reload our ChannelManager.
620                         {
621                                 let mut channel_monitors = new_hash_map();
622                                 for monitor in deserialized_monitors.iter_mut() {
623                                         channel_monitors.insert(monitor.get_funding_txo().0, monitor);
624                                 }
625
626                                 let scorer = RwLock::new(test_utils::TestScorer::new());
627                                 let mut w = test_utils::TestVecWriter(Vec::new());
628                                 self.node.write(&mut w).unwrap();
629                                 <(BlockHash, ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
630                                         default_config: *self.node.get_current_default_configuration(),
631                                         entropy_source: self.keys_manager,
632                                         node_signer: self.keys_manager,
633                                         signer_provider: self.keys_manager,
634                                         fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
635                                         router: &test_utils::TestRouter::new(Arc::new(network_graph), &self.logger, &scorer),
636                                         chain_monitor: self.chain_monitor,
637                                         tx_broadcaster: &broadcaster,
638                                         logger: &self.logger,
639                                         channel_monitors,
640                                 }).unwrap();
641                         }
642
643                         let persister = test_utils::TestPersister::new();
644                         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
645                         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
646                         for deserialized_monitor in deserialized_monitors.drain(..) {
647                                 let funding_outpoint = deserialized_monitor.get_funding_txo().0;
648                                 if chain_monitor.watch_channel(funding_outpoint, deserialized_monitor) != Ok(ChannelMonitorUpdateStatus::Completed) {
649                                         panic!();
650                                 }
651                         }
652                         assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
653                         assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
654                 }
655         }
656 }
657
658 pub fn create_chan_between_nodes<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
659         create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
660 }
661
662 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
663         let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
664         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
665         (announcement, as_update, bs_update, channel_id, tx)
666 }
667
668 /// Gets an RAA and CS which were sent in response to a commitment update
669 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
670         let events = node.node().get_and_clear_pending_msg_events();
671         assert_eq!(events.len(), 2);
672         (match events[0] {
673                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
674                         assert_eq!(node_id, recipient);
675                         (*msg).clone()
676                 },
677                 _ => panic!("Unexpected event"),
678         }, match events[1] {
679                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
680                         assert_eq!(node_id, recipient);
681                         assert!(updates.update_add_htlcs.is_empty());
682                         assert!(updates.update_fulfill_htlcs.is_empty());
683                         assert!(updates.update_fail_htlcs.is_empty());
684                         assert!(updates.update_fail_malformed_htlcs.is_empty());
685                         assert!(updates.update_fee.is_none());
686                         updates.commitment_signed.clone()
687                 },
688                 _ => panic!("Unexpected event"),
689         })
690 }
691
692 #[macro_export]
693 /// Gets an RAA and CS which were sent in response to a commitment update
694 ///
695 /// Don't use this, use the identically-named function instead.
696 macro_rules! get_revoke_commit_msgs {
697         ($node: expr, $node_id: expr) => {
698                 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
699         }
700 }
701
702 /// Get an specific event message from the pending events queue.
703 #[macro_export]
704 macro_rules! get_event_msg {
705         ($node: expr, $event_type: path, $node_id: expr) => {
706                 {
707                         let events = $node.node.get_and_clear_pending_msg_events();
708                         assert_eq!(events.len(), 1);
709                         match events[0] {
710                                 $event_type { ref node_id, ref msg } => {
711                                         assert_eq!(*node_id, $node_id);
712                                         (*msg).clone()
713                                 },
714                                 _ => panic!("Unexpected event"),
715                         }
716                 }
717         }
718 }
719
720 /// Get an error message from the pending events queue.
721 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
722         let events = node.node.get_and_clear_pending_msg_events();
723         assert_eq!(events.len(), 1);
724         match events[0] {
725                 MessageSendEvent::HandleError {
726                         action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
727                 } => {
728                         assert_eq!(node_id, recipient);
729                         (*msg).clone()
730                 },
731                 MessageSendEvent::HandleError {
732                         action: msgs::ErrorAction::DisconnectPeer { ref msg }, ref node_id
733                 } => {
734                         assert_eq!(node_id, recipient);
735                         msg.as_ref().unwrap().clone()
736                 },
737                 _ => panic!("Unexpected event"),
738         }
739 }
740
741 /// Get a specific event from the pending events queue.
742 #[macro_export]
743 macro_rules! get_event {
744         ($node: expr, $event_type: path) => {
745                 {
746                         let mut events = $node.node.get_and_clear_pending_events();
747                         assert_eq!(events.len(), 1);
748                         let ev = events.pop().unwrap();
749                         match ev {
750                                 $event_type { .. } => {
751                                         ev
752                                 },
753                                 _ => panic!("Unexpected event"),
754                         }
755                 }
756         }
757 }
758
759 /// Gets an UpdateHTLCs MessageSendEvent
760 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
761         let events = node.node.get_and_clear_pending_msg_events();
762         assert_eq!(events.len(), 1);
763         match events[0] {
764                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
765                         assert_eq!(node_id, recipient);
766                         (*updates).clone()
767                 },
768                 _ => panic!("Unexpected event"),
769         }
770 }
771
772 #[macro_export]
773 /// Gets an UpdateHTLCs MessageSendEvent
774 ///
775 /// Don't use this, use the identically-named function instead.
776 macro_rules! get_htlc_update_msgs {
777         ($node: expr, $node_id: expr) => {
778                 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
779         }
780 }
781
782 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
783 /// Returns the `msg_event`.
784 ///
785 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
786 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
787 /// such messages are intended to all peers.
788 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
789         let ev_index = msg_events.iter().position(|e| { match e {
790                 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
791                         node_id == msg_node_id
792                 },
793                 MessageSendEvent::SendOpenChannel { node_id, .. } => {
794                         node_id == msg_node_id
795                 },
796                 MessageSendEvent::SendFundingCreated { node_id, .. } => {
797                         node_id == msg_node_id
798                 },
799                 MessageSendEvent::SendFundingSigned { node_id, .. } => {
800                         node_id == msg_node_id
801                 },
802                 MessageSendEvent::SendChannelReady { node_id, .. } => {
803                         node_id == msg_node_id
804                 },
805                 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
806                         node_id == msg_node_id
807                 },
808                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
809                         node_id == msg_node_id
810                 },
811                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
812                         node_id == msg_node_id
813                 },
814                 MessageSendEvent::SendClosingSigned { node_id, .. } => {
815                         node_id == msg_node_id
816                 },
817                 MessageSendEvent::SendShutdown { node_id, .. } => {
818                         node_id == msg_node_id
819                 },
820                 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
821                         node_id == msg_node_id
822                 },
823                 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
824                         node_id == msg_node_id
825                 },
826                 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
827                         false
828                 },
829                 MessageSendEvent::BroadcastChannelUpdate { .. } => {
830                         false
831                 },
832                 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
833                         false
834                 },
835                 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
836                         node_id == msg_node_id
837                 },
838                 MessageSendEvent::HandleError { node_id, .. } => {
839                         node_id == msg_node_id
840                 },
841                 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
842                         node_id == msg_node_id
843                 },
844                 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
845                         node_id == msg_node_id
846                 },
847                 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
848                         node_id == msg_node_id
849                 },
850                 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
851                         node_id == msg_node_id
852                 },
853                 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
854                         node_id == msg_node_id
855                 },
856                 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
857                         node_id == msg_node_id
858                 },
859                 MessageSendEvent::SendStfu { node_id, .. } => {
860                         node_id == msg_node_id
861                 },
862                 MessageSendEvent::SendSplice { node_id, .. } => {
863                         node_id == msg_node_id
864                 },
865                 MessageSendEvent::SendSpliceAck { node_id, .. } => {
866                         node_id == msg_node_id
867                 },
868                 MessageSendEvent::SendSpliceLocked { node_id, .. } => {
869                         node_id == msg_node_id
870                 },
871                 MessageSendEvent::SendTxAddInput { node_id, .. } => {
872                         node_id == msg_node_id
873                 },
874                 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
875                         node_id == msg_node_id
876                 },
877                 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
878                         node_id == msg_node_id
879                 },
880                 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
881                         node_id == msg_node_id
882                 },
883                 MessageSendEvent::SendTxComplete { node_id, .. } => {
884                         node_id == msg_node_id
885                 },
886                 MessageSendEvent::SendTxSignatures { node_id, .. } => {
887                         node_id == msg_node_id
888                 },
889                 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
890                         node_id == msg_node_id
891                 },
892                 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
893                         node_id == msg_node_id
894                 },
895                 MessageSendEvent::SendTxAbort { node_id, .. } => {
896                         node_id == msg_node_id
897                 },
898         }});
899         if ev_index.is_some() {
900                 msg_events.remove(ev_index.unwrap())
901         } else {
902                 panic!("Couldn't find any MessageSendEvent to the node!")
903         }
904 }
905
906 #[cfg(test)]
907 macro_rules! get_channel_ref {
908         ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
909                 {
910                         $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
911                         $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
912                         $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
913                 }
914         }
915 }
916
917 #[cfg(test)]
918 macro_rules! get_feerate {
919         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
920                 {
921                         let mut per_peer_state_lock;
922                         let mut peer_state_lock;
923                         let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
924                         phase.context().get_feerate_sat_per_1000_weight()
925                 }
926         }
927 }
928
929 #[cfg(test)]
930 macro_rules! get_channel_type_features {
931         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
932                 {
933                         let mut per_peer_state_lock;
934                         let mut peer_state_lock;
935                         let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
936                         chan.context().get_channel_type().clone()
937                 }
938         }
939 }
940
941 /// Returns a channel monitor given a channel id, making some naive assumptions
942 #[macro_export]
943 macro_rules! get_monitor {
944         ($node: expr, $channel_id: expr) => {
945                 {
946                         use bitcoin::hashes::Hash;
947                         let mut monitor = None;
948                         // Assume funding vout is either 0 or 1 blindly
949                         for index in 0..2 {
950                                 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
951                                         $crate::chain::transaction::OutPoint {
952                                                 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
953                                         })
954                                 {
955                                         monitor = Some(mon);
956                                         break;
957                                 }
958                         }
959                         monitor.unwrap()
960                 }
961         }
962 }
963
964 /// Returns any local commitment transactions for the channel.
965 #[macro_export]
966 macro_rules! get_local_commitment_txn {
967         ($node: expr, $channel_id: expr) => {
968                 {
969                         $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
970                 }
971         }
972 }
973
974 /// Check the error from attempting a payment.
975 #[macro_export]
976 macro_rules! unwrap_send_err {
977         ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
978                 match &$res {
979                         &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
980                                 assert_eq!(fails.len(), 1);
981                                 match fails[0] {
982                                         $type => { $check },
983                                         _ => panic!(),
984                                 }
985                         },
986                         &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
987                                 assert_eq!(results.len(), 1);
988                                 match results[0] {
989                                         Err($type) => { $check },
990                                         _ => panic!(),
991                                 }
992                         },
993                         &Err(PaymentSendFailure::PathParameterError(ref result)) if !$all_failed => {
994                                 assert_eq!(result.len(), 1);
995                                 match result[0] {
996                                         Err($type) => { $check },
997                                         _ => panic!(),
998                                 }
999                         },
1000                         _ => {panic!()},
1001                 }
1002         }
1003 }
1004
1005 /// Check whether N channel monitor(s) have been added.
1006 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
1007         if let Some(chain_monitor) = node.chain_monitor() {
1008                 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
1009                 let n = added_monitors.len();
1010                 assert_eq!(n, count, "expected {} monitors to be added, not {}", count, n);
1011                 added_monitors.clear();
1012         }
1013 }
1014
1015 /// Check whether N channel monitor(s) have been added.
1016 ///
1017 /// Don't use this, use the identically-named function instead.
1018 #[macro_export]
1019 macro_rules! check_added_monitors {
1020         ($node: expr, $count: expr) => {
1021                 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
1022         }
1023 }
1024
1025 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
1026 ///
1027 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
1028 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
1029 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
1030         let mut nodes = path.iter().rev();
1031         let dest = nodes.next().expect("path should have a destination").node;
1032         let prev = nodes.next().unwrap_or(&origin_node).node;
1033         let dest_channels = dest.list_channels();
1034         let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
1035                 .expect("HTLC's channel should be one of destination node's channels");
1036         assert_eq!(htlc.user_channel_id, ch.user_channel_id);
1037         assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
1038 }
1039
1040 pub fn _reload_node<'a, 'b, 'c>(node: &'a Node<'a, 'b, 'c>, default_config: UserConfig, chanman_encoded: &[u8], monitors_encoded: &[&[u8]]) -> TestChannelManager<'b, 'c> {
1041         let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
1042         for encoded in monitors_encoded {
1043                 let mut monitor_read = &encoded[..];
1044                 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
1045                         ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
1046                 assert!(monitor_read.is_empty());
1047                 monitors_read.push(monitor);
1048         }
1049
1050         let mut node_read = &chanman_encoded[..];
1051         let (_, node_deserialized) = {
1052                 let mut channel_monitors = new_hash_map();
1053                 for monitor in monitors_read.iter_mut() {
1054                         assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
1055                 }
1056                 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
1057                         default_config,
1058                         entropy_source: node.keys_manager,
1059                         node_signer: node.keys_manager,
1060                         signer_provider: node.keys_manager,
1061                         fee_estimator: node.fee_estimator,
1062                         router: node.router,
1063                         chain_monitor: node.chain_monitor,
1064                         tx_broadcaster: node.tx_broadcaster,
1065                         logger: node.logger,
1066                         channel_monitors,
1067                 }).unwrap()
1068         };
1069         assert!(node_read.is_empty());
1070
1071         for monitor in monitors_read.drain(..) {
1072                 let funding_outpoint = monitor.get_funding_txo().0;
1073                 assert_eq!(node.chain_monitor.watch_channel(funding_outpoint, monitor),
1074                         Ok(ChannelMonitorUpdateStatus::Completed));
1075                 check_added_monitors!(node, 1);
1076         }
1077
1078         node_deserialized
1079 }
1080
1081 #[cfg(test)]
1082 macro_rules! reload_node {
1083         ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1084                 let chanman_encoded = $chanman_encoded;
1085
1086                 $persister = test_utils::TestPersister::new();
1087                 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1088                 $node.chain_monitor = &$new_chain_monitor;
1089
1090                 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1091                 $node.node = &$new_channelmanager;
1092                 $node.onion_messenger.set_offers_handler(&$new_channelmanager);
1093         };
1094         ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1095                 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1096         };
1097 }
1098
1099 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1100         expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1101  -> (ChannelId, Transaction, OutPoint)
1102 {
1103         internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1104 }
1105
1106 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1107         expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1108  -> (ChannelId, Transaction, OutPoint)
1109 {
1110         internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1111 }
1112
1113 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1114         expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1115         coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1116         let chan_id = *node.network_chan_count.borrow();
1117
1118         let events = node.node.get_and_clear_pending_events();
1119         assert_eq!(events.len(), 1);
1120         match events[0] {
1121                 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1122                         assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1123                         assert_eq!(*channel_value_satoshis, expected_chan_value);
1124                         assert_eq!(user_channel_id, expected_user_chan_id);
1125
1126                         let input = if coinbase {
1127                                 vec![TxIn {
1128                                         previous_output: bitcoin::OutPoint::null(),
1129                                         ..Default::default()
1130                                 }]
1131                         } else {
1132                                 Vec::new()
1133                         };
1134
1135                         let tx = Transaction { version: chan_id as i32, lock_time: LockTime::ZERO, input, output: vec![TxOut {
1136                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1137                         }]};
1138                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1139                         (*temporary_channel_id, tx, funding_outpoint)
1140                 },
1141                 _ => panic!("Unexpected event"),
1142         }
1143 }
1144
1145 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: ChannelId) -> Transaction {
1146         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1147         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1148
1149         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1150         check_added_monitors!(node_a, 0);
1151
1152         let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1153         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1154         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1155         {
1156                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1157                 assert_eq!(added_monitors.len(), 1);
1158                 assert_eq!(added_monitors[0].0, funding_output);
1159                 added_monitors.clear();
1160         }
1161         expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1162
1163         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()));
1164         {
1165                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1166                 assert_eq!(added_monitors.len(), 1);
1167                 assert_eq!(added_monitors[0].0, funding_output);
1168                 added_monitors.clear();
1169         }
1170         expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1171
1172         let events_4 = node_a.node.get_and_clear_pending_events();
1173         assert_eq!(events_4.len(), 0);
1174
1175         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1176         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1177         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1178
1179         // Ensure that funding_transaction_generated is idempotent.
1180         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1181         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1182         check_added_monitors!(node_a, 0);
1183
1184         tx
1185 }
1186
1187 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1188 pub fn open_zero_conf_channel<'a, 'b, 'c, 'd>(initiator: &'a Node<'b, 'c, 'd>, receiver: &'a Node<'b, 'c, 'd>, initiator_config: Option<UserConfig>) -> (bitcoin::Transaction, ChannelId) {
1189         let initiator_channels = initiator.node.list_usable_channels().len();
1190         let receiver_channels = receiver.node.list_usable_channels().len();
1191
1192         initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, None, initiator_config).unwrap();
1193         let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1194
1195         receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1196         let events = receiver.node.get_and_clear_pending_events();
1197         assert_eq!(events.len(), 1);
1198         match events[0] {
1199                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1200                         receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1201                 },
1202                 _ => panic!("Unexpected event"),
1203         };
1204
1205         let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1206         assert_eq!(accept_channel.minimum_depth, 0);
1207         initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1208
1209         let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1210         initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1211         let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1212
1213         receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1214         check_added_monitors!(receiver, 1);
1215         let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1216         assert_eq!(bs_signed_locked.len(), 2);
1217         let as_channel_ready;
1218         match &bs_signed_locked[0] {
1219                 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1220                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1221                         initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1222                         expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1223                         expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1224                         check_added_monitors!(initiator, 1);
1225
1226                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1227                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1228
1229                         as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1230                 }
1231                 _ => panic!("Unexpected event"),
1232         }
1233         match &bs_signed_locked[1] {
1234                 MessageSendEvent::SendChannelReady { node_id, msg } => {
1235                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1236                         initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1237                         expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1238                 }
1239                 _ => panic!("Unexpected event"),
1240         }
1241
1242         receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1243         expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1244
1245         let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1246         let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1247
1248         initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1249         receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1250
1251         assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1252         assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1253
1254         (tx, as_channel_ready.channel_id)
1255 }
1256
1257 pub fn exchange_open_accept_chan<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, push_msat: u64) -> ChannelId {
1258         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None, None).unwrap();
1259         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1260         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1261         assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1262         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1263         if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1264                 let events = node_b.node.get_and_clear_pending_events();
1265                 assert_eq!(events.len(), 1);
1266                 match &events[0] {
1267                         Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1268                                 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1269                         _ => panic!("Unexpected event"),
1270                 };
1271         }
1272         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1273         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1274         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1275         assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1276
1277         create_chan_id
1278 }
1279
1280 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) -> Transaction {
1281         let create_chan_id = exchange_open_accept_chan(node_a, node_b, channel_value, push_msat);
1282         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1283 }
1284
1285 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) {
1286         confirm_transaction_at(node_conf, tx, conf_height);
1287         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1288         node_recv.node.handle_channel_ready(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendChannelReady, node_recv.node.get_our_node_id()));
1289 }
1290
1291 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::ChannelReady, msgs::AnnouncementSignatures), ChannelId) {
1292         let channel_id;
1293         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1294         assert_eq!(events_6.len(), 3);
1295         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1296                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1297                 2
1298         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1299                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1300                 1
1301         } else { panic!("Unexpected event: {:?}", events_6[1]); };
1302         ((match events_6[0] {
1303                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1304                         channel_id = msg.channel_id.clone();
1305                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1306                         msg.clone()
1307                 },
1308                 _ => panic!("Unexpected event"),
1309         }, match events_6[announcement_sigs_idx] {
1310                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1311                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1312                         msg.clone()
1313                 },
1314                 _ => panic!("Unexpected event"),
1315         }), channel_id)
1316 }
1317
1318 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), ChannelId) {
1319         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1320         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1321         confirm_transaction_at(node_a, tx, conf_height);
1322         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1323         expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1324         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1325 }
1326
1327 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), ChannelId, Transaction) {
1328         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1329         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1330         (msgs, chan_id, tx)
1331 }
1332
1333 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::ChannelReady, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
1334         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1335         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1336         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1337
1338         let events_7 = node_b.node.get_and_clear_pending_msg_events();
1339         assert_eq!(events_7.len(), 1);
1340         let (announcement, bs_update) = match events_7[0] {
1341                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1342                         (msg, update_msg.clone().unwrap())
1343                 },
1344                 _ => panic!("Unexpected event"),
1345         };
1346
1347         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1348         let events_8 = node_a.node.get_and_clear_pending_msg_events();
1349         assert_eq!(events_8.len(), 1);
1350         let as_update = match events_8[0] {
1351                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1352                         assert!(*announcement == *msg);
1353                         let update_msg = update_msg.clone().unwrap();
1354                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1355                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1356                         update_msg
1357                 },
1358                 _ => panic!("Unexpected event"),
1359         };
1360
1361         *node_a.network_chan_count.borrow_mut() += 1;
1362
1363         expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1364         ((*announcement).clone(), as_update, bs_update)
1365 }
1366
1367 pub fn create_announced_chan_between_nodes<'a, 'b, 'c: 'd, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
1368         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1369 }
1370
1371 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c: 'd, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
1372         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1373         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1374         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1375 }
1376
1377 pub fn create_unannounced_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) -> (msgs::ChannelReady, Transaction) {
1378         let mut no_announce_cfg = test_default_channel_config();
1379         no_announce_cfg.channel_handshake_config.announced_channel = false;
1380         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, None, Some(no_announce_cfg)).unwrap();
1381         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1382         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1383         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1384         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1385
1386         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1387         nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1388         nodes[b].node.handle_funding_created(&nodes[a].node.get_our_node_id(), &get_event_msg!(nodes[a], MessageSendEvent::SendFundingCreated, nodes[b].node.get_our_node_id()));
1389         check_added_monitors!(nodes[b], 1);
1390
1391         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1392         expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1393
1394         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1395         expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1396         check_added_monitors!(nodes[a], 1);
1397
1398         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1399         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1400         nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1401
1402         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1403         confirm_transaction_at(&nodes[a], &tx, conf_height);
1404         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1405         confirm_transaction_at(&nodes[b], &tx, conf_height);
1406         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1407         let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1408         nodes[a].node.handle_channel_ready(&nodes[b].node.get_our_node_id(), &get_event_msg!(nodes[b], MessageSendEvent::SendChannelReady, nodes[a].node.get_our_node_id()));
1409         expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1410         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1411         nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1412         expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1413         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1414
1415         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1416         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1417
1418         let mut found_a = false;
1419         for chan in nodes[a].node.list_usable_channels() {
1420                 if chan.channel_id == as_channel_ready.channel_id {
1421                         assert!(!found_a);
1422                         found_a = true;
1423                         assert!(!chan.is_public);
1424                 }
1425         }
1426         assert!(found_a);
1427
1428         let mut found_b = false;
1429         for chan in nodes[b].node.list_usable_channels() {
1430                 if chan.channel_id == as_channel_ready.channel_id {
1431                         assert!(!found_b);
1432                         found_b = true;
1433                         assert!(!chan.is_public);
1434                 }
1435         }
1436         assert!(found_b);
1437
1438         (as_channel_ready, tx)
1439 }
1440
1441 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) {
1442         for node in nodes {
1443                 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1444                 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1445                 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1446
1447                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1448                 // forwarding info for local channels even if its not accepted in the network graph.
1449                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1450                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1451         }
1452 }
1453
1454 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1455         for outp in tx.output.iter() {
1456                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1457         }
1458         let mut total_value_in = 0;
1459         for input in tx.input.iter() {
1460                 total_value_in += get_output(&input.previous_output).unwrap().value;
1461         }
1462         let mut total_value_out = 0;
1463         for output in tx.output.iter() {
1464                 total_value_out += output.value;
1465         }
1466         let min_fee = (tx.weight().to_wu() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1467         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1468         assert!(total_value_out + min_fee <= total_value_in);
1469         tx.verify(get_output).unwrap();
1470 }
1471
1472 #[macro_export]
1473 macro_rules! check_spends {
1474         ($tx: expr, $($spends_txn: expr),*) => {
1475                 {
1476                         $(
1477                         for outp in $spends_txn.output.iter() {
1478                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1479                         }
1480                         )*
1481                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1482                                 $(
1483                                         if out_point.txid == $spends_txn.txid() {
1484                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
1485                                         }
1486                                 )*
1487                                 None
1488                         };
1489                         $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1490                 }
1491         }
1492 }
1493
1494 macro_rules! get_closing_signed_broadcast {
1495         ($node: expr, $dest_pubkey: expr) => {
1496                 {
1497                         let events = $node.get_and_clear_pending_msg_events();
1498                         assert!(events.len() == 1 || events.len() == 2);
1499                         (match events[events.len() - 1] {
1500                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1501                                         assert_eq!(msg.contents.flags & 2, 2);
1502                                         msg.clone()
1503                                 },
1504                                 _ => panic!("Unexpected event"),
1505                         }, if events.len() == 2 {
1506                                 match events[0] {
1507                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1508                                                 assert_eq!(*node_id, $dest_pubkey);
1509                                                 Some(msg.clone())
1510                                         },
1511                                         _ => panic!("Unexpected event"),
1512                                 }
1513                         } else { None })
1514                 }
1515         }
1516 }
1517
1518 #[cfg(test)]
1519 macro_rules! check_warn_msg {
1520         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1521                 let msg_events = $node.node.get_and_clear_pending_msg_events();
1522                 assert_eq!(msg_events.len(), 1);
1523                 match msg_events[0] {
1524                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1525                                 assert_eq!(node_id, $recipient_node_id);
1526                                 assert_eq!(msg.channel_id, $chan_id);
1527                                 msg.data.clone()
1528                         },
1529                         _ => panic!("Unexpected event"),
1530                 }
1531         }}
1532 }
1533
1534 /// Check that a channel's closing channel update has been broadcasted, and optionally
1535 /// check whether an error message event has occurred.
1536 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1537         let msg_events = node.node.get_and_clear_pending_msg_events();
1538         assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1539         msg_events.into_iter().filter_map(|msg_event| {
1540                 match msg_event {
1541                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1542                                 assert_eq!(msg.contents.flags & 2, 2);
1543                                 None
1544                         },
1545                         MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1546                                 assert!(with_error_msg);
1547                                 // TODO: Check node_id
1548                                 Some(msg)
1549                         },
1550                         MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1551                                 assert!(with_error_msg);
1552                                 // TODO: Check node_id
1553                                 Some(msg.unwrap())
1554                         },
1555                         _ => panic!("Unexpected event"),
1556                 }
1557         }).collect()
1558 }
1559
1560 /// Check that a channel's closing channel update has been broadcasted, and optionally
1561 /// check whether an error message event has occurred.
1562 ///
1563 /// Don't use this, use the identically-named function instead.
1564 #[macro_export]
1565 macro_rules! check_closed_broadcast {
1566         ($node: expr, $with_error_msg: expr) => {
1567                 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1568         }
1569 }
1570
1571 #[derive(Default)]
1572 pub struct ExpectedCloseEvent {
1573         pub channel_capacity_sats: Option<u64>,
1574         pub channel_id: Option<ChannelId>,
1575         pub counterparty_node_id: Option<PublicKey>,
1576         pub discard_funding: bool,
1577         pub reason: Option<ClosureReason>,
1578         pub channel_funding_txo: Option<OutPoint>,
1579         pub user_channel_id: Option<u128>,
1580 }
1581
1582 impl ExpectedCloseEvent {
1583         pub fn from_id_reason(channel_id: ChannelId, discard_funding: bool, reason: ClosureReason) -> Self {
1584                 Self {
1585                         channel_capacity_sats: None,
1586                         channel_id: Some(channel_id),
1587                         counterparty_node_id: None,
1588                         discard_funding,
1589                         reason: Some(reason),
1590                         channel_funding_txo: None,
1591                         user_channel_id: None,
1592                 }
1593         }
1594 }
1595
1596 /// Check that multiple channel closing events have been issued.
1597 pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEvent]) {
1598         let closed_events_count = expected_close_events.len();
1599         let discard_events_count = expected_close_events.iter().filter(|e| e.discard_funding).count();
1600         let events = node.node.get_and_clear_pending_events();
1601         assert_eq!(events.len(), closed_events_count + discard_events_count, "{:?}", events);
1602         for expected_event in expected_close_events {
1603                 assert!(events.iter().any(|e| matches!(
1604                         e,
1605                         Event::ChannelClosed {
1606                                 channel_id,
1607                                 reason,
1608                                 counterparty_node_id,
1609                                 channel_capacity_sats,
1610                                 channel_funding_txo,
1611                                 user_channel_id,
1612                                 ..
1613                         } if (
1614                                 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
1615                                 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
1616                                 expected_event.
1617                                         counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
1618                                 expected_event.channel_capacity_sats
1619                                         .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
1620                                 expected_event.channel_funding_txo
1621                                         .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
1622                                 expected_event.user_channel_id
1623                                         .map(|expected| *user_channel_id == expected).unwrap_or(true)
1624                         )
1625                 )));
1626         }
1627         assert_eq!(events.iter().filter(|e| matches!(
1628                 e,
1629                 Event::DiscardFunding { .. },
1630         )).count(), discard_events_count);
1631 }
1632
1633 /// Check that a channel's closing channel events has been issued
1634 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1635         expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1636         let expected_events_count = if is_check_discard_funding {
1637                 2 * expected_counterparty_node_ids.len()
1638         } else {
1639                 expected_counterparty_node_ids.len()
1640         };
1641         assert_eq!(events_count, expected_events_count);
1642         let expected_close_events = expected_counterparty_node_ids.iter().map(|node_id| ExpectedCloseEvent {
1643                 channel_capacity_sats: Some(expected_channel_capacity),
1644                 channel_id: None,
1645                 counterparty_node_id: Some(*node_id),
1646                 discard_funding: is_check_discard_funding,
1647                 reason: Some(expected_reason.clone()),
1648                 channel_funding_txo: None,
1649                 user_channel_id: None,
1650         }).collect::<Vec<_>>();
1651         check_closed_events(node, expected_close_events.as_slice());
1652 }
1653
1654 /// Check that a channel's closing channel events has been issued
1655 ///
1656 /// Don't use this, use the identically-named function instead.
1657 #[macro_export]
1658 macro_rules! check_closed_event {
1659         ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1660                 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1661         };
1662         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1663                 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1664                         $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1665         }
1666 }
1667
1668 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1669         let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1670         assert_eq!(events.len(), count);
1671         for event in events {
1672                 match event {
1673                         Event::BumpTransaction(bump_event) => {
1674                                 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1675                                 else { panic!(); }
1676                                 node.bump_tx_handler.handle_event(&bump_event);
1677                         },
1678                         _ => panic!(),
1679                 }
1680         }
1681 }
1682
1683 pub fn close_channel<'a, 'b, 'c>(outbound_node: &Node<'a, 'b, 'c>, inbound_node: &Node<'a, 'b, 'c>, channel_id: &ChannelId, funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
1684         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) };
1685         let (node_b, broadcaster_b, struct_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) } else { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) };
1686         let (tx_a, tx_b);
1687
1688         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1689         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1690
1691         let events_1 = node_b.get_and_clear_pending_msg_events();
1692         assert!(events_1.len() >= 1);
1693         let shutdown_b = match events_1[0] {
1694                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1695                         assert_eq!(node_id, &node_a.get_our_node_id());
1696                         msg.clone()
1697                 },
1698                 _ => panic!("Unexpected event"),
1699         };
1700
1701         let closing_signed_b = if !close_inbound_first {
1702                 assert_eq!(events_1.len(), 1);
1703                 None
1704         } else {
1705                 Some(match events_1[1] {
1706                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1707                                 assert_eq!(node_id, &node_a.get_our_node_id());
1708                                 msg.clone()
1709                         },
1710                         _ => panic!("Unexpected event"),
1711                 })
1712         };
1713
1714         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1715         let (as_update, bs_update) = if close_inbound_first {
1716                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1717                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1718
1719                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1720                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1721                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1722                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1723
1724                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1725                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1726                 assert!(none_a.is_none());
1727                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1728                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1729                 (as_update, bs_update)
1730         } else {
1731                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1732
1733                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1734                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1735
1736                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1737                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1738                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1739
1740                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1741                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1742                 assert!(none_b.is_none());
1743                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1744                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1745                 (as_update, bs_update)
1746         };
1747         assert_eq!(tx_a, tx_b);
1748         check_spends!(tx_a, funding_tx);
1749
1750         (as_update, bs_update, tx_a)
1751 }
1752
1753 pub struct SendEvent {
1754         pub node_id: PublicKey,
1755         pub msgs: Vec<msgs::UpdateAddHTLC>,
1756         pub commitment_msg: msgs::CommitmentSigned,
1757 }
1758 impl SendEvent {
1759         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1760                 assert!(updates.update_fulfill_htlcs.is_empty());
1761                 assert!(updates.update_fail_htlcs.is_empty());
1762                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1763                 assert!(updates.update_fee.is_none());
1764                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1765         }
1766
1767         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1768                 match event {
1769                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1770                         _ => panic!("Unexpected event type!"),
1771                 }
1772         }
1773
1774         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1775                 let mut events = node.node.get_and_clear_pending_msg_events();
1776                 assert_eq!(events.len(), 1);
1777                 SendEvent::from_event(events.pop().unwrap())
1778         }
1779 }
1780
1781 #[macro_export]
1782 /// Don't use this, use the identically-named function instead.
1783 macro_rules! expect_pending_htlcs_forwardable_conditions {
1784         ($node: expr, $expected_failures: expr) => {
1785                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1786         }
1787 }
1788
1789 #[macro_export]
1790 macro_rules! expect_htlc_handling_failed_destinations {
1791         ($events: expr, $expected_failures: expr) => {{
1792                 for event in $events {
1793                         match event {
1794                                 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1795                                 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1796                                         assert!($expected_failures.contains(&failed_next_destination))
1797                                 },
1798                                 _ => panic!("Unexpected destination"),
1799                         }
1800                 }
1801         }}
1802 }
1803
1804 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1805 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1806 /// `expected_failures` set.
1807 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1808         match events[0] {
1809                 Event::PendingHTLCsForwardable { .. } => { },
1810                 _ => panic!("Unexpected event {:?}", events),
1811         };
1812
1813         let count = expected_failures.len() + 1;
1814         assert_eq!(events.len(), count);
1815
1816         if expected_failures.len() > 0 {
1817                 expect_htlc_handling_failed_destinations!(events, expected_failures)
1818         }
1819 }
1820
1821 #[macro_export]
1822 /// Clears (and ignores) a PendingHTLCsForwardable event
1823 ///
1824 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1825 /// set instead.
1826 macro_rules! expect_pending_htlcs_forwardable_ignore {
1827         ($node: expr) => {
1828                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1829         }
1830 }
1831
1832 #[macro_export]
1833 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1834 ///
1835 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1836 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1837         ($node: expr, $expected_failures: expr) => {
1838                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1839         }
1840 }
1841
1842 #[macro_export]
1843 /// Handles a PendingHTLCsForwardable event
1844 macro_rules! expect_pending_htlcs_forwardable {
1845         ($node: expr) => {{
1846                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1847                 $node.node.process_pending_htlc_forwards();
1848
1849                 // Ensure process_pending_htlc_forwards is idempotent.
1850                 $node.node.process_pending_htlc_forwards();
1851         }};
1852 }
1853
1854 #[macro_export]
1855 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1856 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1857         ($node: expr, $expected_failures: expr) => {{
1858                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1859                 $node.node.process_pending_htlc_forwards();
1860
1861                 // Ensure process_pending_htlc_forwards is idempotent.
1862                 $node.node.process_pending_htlc_forwards();
1863         }}
1864 }
1865
1866 #[cfg(test)]
1867 macro_rules! expect_pending_htlcs_forwardable_from_events {
1868         ($node: expr, $events: expr, $ignore: expr) => {{
1869                 assert_eq!($events.len(), 1);
1870                 match $events[0] {
1871                         Event::PendingHTLCsForwardable { .. } => { },
1872                         _ => panic!("Unexpected event"),
1873                 };
1874                 if $ignore {
1875                         $node.node.process_pending_htlc_forwards();
1876
1877                         // Ensure process_pending_htlc_forwards is idempotent.
1878                         $node.node.process_pending_htlc_forwards();
1879                 }
1880         }}
1881 }
1882
1883 #[macro_export]
1884 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1885 /// commitment update.
1886 macro_rules! commitment_signed_dance {
1887         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1888                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1889         };
1890         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1891                 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1892         };
1893         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1894                 {
1895                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1896                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1897                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1898                         check_added_monitors(&$node_a, 1);
1899                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1900                         assert!(extra_msg_option.is_none());
1901                         bs_revoke_and_ack
1902                 }
1903         };
1904         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1905                 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1906         };
1907         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1908                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1909         }
1910 }
1911
1912 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1913 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1914 /// `revoke_and_ack` response to it.
1915 ///
1916 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1917 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1918 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1919 /// the commitment we're exchanging. `includes_claim` provides that information.
1920 ///
1921 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1922 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1923         let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1924         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1925         check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1926         extra_msg_option
1927 }
1928
1929 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1930 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1931 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1932 /// have included.
1933 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1934         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1935         check_added_monitors!(node_b, 0);
1936         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1937         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1938         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1939         check_added_monitors!(node_b, 1);
1940         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1941         let (bs_revoke_and_ack, extra_msg_option) = {
1942                 let mut events = node_b.node.get_and_clear_pending_msg_events();
1943                 assert!(events.len() <= 2);
1944                 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1945                 (match node_a_event {
1946                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1947                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1948                                 (*msg).clone()
1949                         },
1950                         _ => panic!("Unexpected event"),
1951                 }, events.get(0).map(|e| e.clone()))
1952         };
1953         check_added_monitors!(node_b, 1);
1954         if fail_backwards {
1955                 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1956                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1957         }
1958         (extra_msg_option, bs_revoke_and_ack)
1959 }
1960
1961 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1962 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1963 ///
1964 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1965 /// on failure or that no new messages are left over on success.
1966 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1967         check_added_monitors!(node_a, 0);
1968         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1969         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1970         check_added_monitors!(node_a, 1);
1971
1972         // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1973         let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
1974         if fail_backwards { assert!(!got_claim); }
1975         commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1976
1977         if skip_last_step { return; }
1978
1979         if fail_backwards {
1980                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1981                         vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1982                 check_added_monitors!(node_a, 1);
1983
1984                 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1985                 let mut number_of_msg_events = 0;
1986                 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1987                         let peer_state = peer_state_mutex.lock().unwrap();
1988                         let cp_pending_msg_events = &peer_state.pending_msg_events;
1989                         number_of_msg_events += cp_pending_msg_events.len();
1990                         if cp_pending_msg_events.len() == 1 {
1991                                 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1992                                         assert_ne!(*cp_id, node_b.node.get_our_node_id());
1993                                 } else { panic!("Unexpected event"); }
1994                         }
1995                 }
1996                 // Expecting the failure backwards event to the previous hop (not `node_b`)
1997                 assert_eq!(number_of_msg_events, 1);
1998         } else {
1999                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2000         }
2001 }
2002
2003 /// Get a payment preimage and hash.
2004 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2005         let mut payment_count = recipient.network_payment_count.borrow_mut();
2006         let payment_preimage = PaymentPreimage([*payment_count; 32]);
2007         *payment_count += 1;
2008         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
2009         let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
2010         (payment_preimage, payment_hash, payment_secret)
2011 }
2012
2013 /// Get a payment preimage and hash.
2014 ///
2015 /// Don't use this, use the identically-named function instead.
2016 #[macro_export]
2017 macro_rules! get_payment_preimage_hash {
2018         ($dest_node: expr) => {
2019                 get_payment_preimage_hash!($dest_node, None)
2020         };
2021         ($dest_node: expr, $min_value_msat: expr) => {
2022                 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
2023         };
2024         ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
2025                 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
2026         };
2027 }
2028
2029 /// Gets a route from the given sender to the node described in `payment_params`.
2030 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
2031         let scorer = TestScorer::new();
2032         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
2033         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2034         router::get_route(
2035                 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
2036                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
2037                 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
2038         )
2039 }
2040
2041 /// Like `get_route` above, but adds a random CLTV offset to the final hop.
2042 pub fn find_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
2043         let scorer = TestScorer::new();
2044         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
2045         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2046         router::find_route(
2047                 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph,
2048                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
2049                 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
2050         )
2051 }
2052
2053 /// Gets a route from the given sender to the node described in `payment_params`.
2054 ///
2055 /// Don't use this, use the identically-named function instead.
2056 #[macro_export]
2057 macro_rules! get_route {
2058         ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
2059                 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
2060                 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
2061         }}
2062 }
2063
2064 #[cfg(test)]
2065 #[macro_export]
2066 macro_rules! get_route_and_payment_hash {
2067         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
2068                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
2069                         .with_bolt11_features($recv_node.node.bolt11_invoice_features()).unwrap();
2070                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
2071         }};
2072         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
2073                 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
2074         }};
2075         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
2076                 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
2077                 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
2078                 let (payment_preimage, payment_hash, payment_secret) =
2079                         $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
2080                 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
2081                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
2082         }}
2083 }
2084
2085 pub fn check_payment_claimable(
2086         event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
2087         expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
2088         expected_receiver_node_id: PublicKey,
2089 ) {
2090         match event {
2091                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
2092                         assert_eq!(expected_payment_hash, *payment_hash);
2093                         assert_eq!(expected_recv_value, *amount_msat);
2094                         assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
2095                         match purpose {
2096                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2097                                         assert_eq!(&expected_payment_preimage, payment_preimage);
2098                                         assert_eq!(expected_payment_secret, *payment_secret);
2099                                 },
2100                                 _ => {},
2101                         }
2102                 },
2103                 _ => panic!("Unexpected event"),
2104         }
2105 }
2106
2107 #[macro_export]
2108 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2109 macro_rules! expect_payment_claimable {
2110         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
2111                 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
2112         };
2113         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
2114                 let events = $node.node.get_and_clear_pending_events();
2115                 assert_eq!(events.len(), 1);
2116                 $crate::ln::functional_test_utils::check_payment_claimable(&events[0], $expected_payment_hash, $expected_payment_secret, $expected_recv_value, $expected_payment_preimage, $expected_receiver_node_id)
2117         };
2118 }
2119
2120 #[macro_export]
2121 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2122 macro_rules! expect_payment_claimed {
2123         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2124                 let events = $node.node.get_and_clear_pending_events();
2125                 assert_eq!(events.len(), 1);
2126                 match events[0] {
2127                         $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
2128                                 assert_eq!($expected_payment_hash, *payment_hash);
2129                                 assert_eq!($expected_recv_value, amount_msat);
2130                         },
2131                         _ => panic!("Unexpected event"),
2132                 }
2133         }
2134 }
2135
2136 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
2137         expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
2138         expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
2139 ) {
2140         let events = node.node().get_and_clear_pending_events();
2141         let expected_payment_hash = PaymentHash(
2142                 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).to_byte_array());
2143         if expect_per_path_claims {
2144                 assert!(events.len() > 1);
2145         } else {
2146                 assert_eq!(events.len(), 1);
2147         }
2148         if expect_post_ev_mon_update {
2149                 check_added_monitors(node, 1);
2150         }
2151         let expected_payment_id = match events[0] {
2152                 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
2153                         assert_eq!(expected_payment_preimage, *payment_preimage);
2154                         assert_eq!(expected_payment_hash, *payment_hash);
2155                         if let Some(expected_fee_msat) = expected_fee_msat_opt {
2156                                 assert_eq!(*fee_paid_msat, expected_fee_msat);
2157                         } else {
2158                                 assert!(fee_paid_msat.is_some());
2159                         }
2160                         payment_id.unwrap()
2161                 },
2162                 _ => panic!("Unexpected event"),
2163         };
2164         if expect_per_path_claims {
2165                 for i in 1..events.len() {
2166                         match events[i] {
2167                                 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2168                                         assert_eq!(payment_id, expected_payment_id);
2169                                         assert_eq!(payment_hash, Some(expected_payment_hash));
2170                                 },
2171                                 _ => panic!("Unexpected event"),
2172                         }
2173                 }
2174         }
2175 }
2176
2177 #[macro_export]
2178 macro_rules! expect_payment_sent {
2179         ($node: expr, $expected_payment_preimage: expr) => {
2180                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2181         };
2182         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2183                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2184         };
2185         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2186                 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2187                         $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2188         }
2189 }
2190
2191 #[cfg(test)]
2192 #[macro_export]
2193 macro_rules! expect_payment_path_successful {
2194         ($node: expr) => {
2195                 let events = $node.node.get_and_clear_pending_events();
2196                 assert_eq!(events.len(), 1);
2197                 match events[0] {
2198                         $crate::events::Event::PaymentPathSuccessful { .. } => {},
2199                         _ => panic!("Unexpected event"),
2200                 }
2201         }
2202 }
2203
2204 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2205         event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2206         expected_extra_fees_msat: Option<u64>, upstream_force_closed: bool,
2207         downstream_force_closed: bool
2208 ) {
2209         match event {
2210                 Event::PaymentForwarded {
2211                         total_fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2212                         outbound_amount_forwarded_msat: _, skimmed_fee_msat
2213                 } => {
2214                         assert_eq!(total_fee_earned_msat, expected_fee);
2215
2216                         // Check that the (knowingly) withheld amount is always less or equal to the expected
2217                         // overpaid amount.
2218                         assert!(skimmed_fee_msat == expected_extra_fees_msat);
2219                         if !upstream_force_closed {
2220                                 // Is the event prev_channel_id in one of the channels between the two nodes?
2221                                 assert!(node.node().list_channels().iter().any(|x| x.counterparty.node_id == prev_node.node().get_our_node_id() && x.channel_id == prev_channel_id.unwrap()));
2222                         }
2223                         // We check for force closures since a force closed channel is removed from the
2224                         // node's channel list
2225                         if !downstream_force_closed {
2226                                 assert!(node.node().list_channels().iter().any(|x| x.counterparty.node_id == next_node.node().get_our_node_id() && x.channel_id == next_channel_id.unwrap()));
2227                         }
2228                         assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2229                 },
2230                 _ => panic!("Unexpected event"),
2231         }
2232 }
2233
2234 #[macro_export]
2235 macro_rules! expect_payment_forwarded {
2236         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2237                 let mut events = $node.node.get_and_clear_pending_events();
2238                 assert_eq!(events.len(), 1);
2239                 $crate::ln::functional_test_utils::expect_payment_forwarded(
2240                         events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee, None,
2241                         $upstream_force_closed, $downstream_force_closed
2242                 );
2243         }
2244 }
2245
2246 #[cfg(test)]
2247 #[macro_export]
2248 macro_rules! expect_channel_shutdown_state {
2249         ($node: expr, $chan_id: expr, $state: path) => {
2250                 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2251                 assert_eq!(chan_details.len(), 1);
2252                 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2253         }
2254 }
2255
2256 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2257 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) -> ChannelId {
2258         let events = node.node.get_and_clear_pending_events();
2259         assert_eq!(events.len(), 1);
2260         match &events[0] {
2261                 crate::events::Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
2262                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2263                         *channel_id
2264                 },
2265                 _ => panic!("Unexpected event"),
2266         }
2267 }
2268
2269 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2270 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2271         let events = node.node.get_and_clear_pending_events();
2272         assert_eq!(events.len(), 1);
2273         match events[0] {
2274                 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2275                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2276                 },
2277                 _ => panic!("Unexpected event"),
2278         }
2279 }
2280
2281 #[cfg(any(test, feature = "_test_utils"))]
2282 pub fn expect_probe_successful_events(node: &Node, mut probe_results: Vec<(PaymentHash, PaymentId)>) {
2283         let mut events = node.node.get_and_clear_pending_events();
2284
2285         for event in events.drain(..) {
2286                 match event {
2287                         Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
2288                                 let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
2289                                 assert!(result_idx.is_some());
2290
2291                                 probe_results.remove(result_idx.unwrap());
2292                         },
2293                         _ => panic!(),
2294                 }
2295         };
2296
2297         // Ensure that we received a ProbeSuccessful event for each probe result.
2298         assert!(probe_results.is_empty());
2299 }
2300
2301 pub struct PaymentFailedConditions<'a> {
2302         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2303         pub(crate) expected_blamed_scid: Option<u64>,
2304         pub(crate) expected_blamed_chan_closed: Option<bool>,
2305         pub(crate) expected_mpp_parts_remain: bool,
2306 }
2307
2308 impl<'a> PaymentFailedConditions<'a> {
2309         pub fn new() -> Self {
2310                 Self {
2311                         expected_htlc_error_data: None,
2312                         expected_blamed_scid: None,
2313                         expected_blamed_chan_closed: None,
2314                         expected_mpp_parts_remain: false,
2315                 }
2316         }
2317         pub fn mpp_parts_remain(mut self) -> Self {
2318                 self.expected_mpp_parts_remain = true;
2319                 self
2320         }
2321         pub fn blamed_scid(mut self, scid: u64) -> Self {
2322                 self.expected_blamed_scid = Some(scid);
2323                 self
2324         }
2325         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2326                 self.expected_blamed_chan_closed = Some(closed);
2327                 self
2328         }
2329         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2330                 self.expected_htlc_error_data = Some((code, data));
2331                 self
2332         }
2333 }
2334
2335 #[cfg(test)]
2336 macro_rules! expect_payment_failed_with_update {
2337         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2338                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2339                         &$node, $expected_payment_hash, $payment_failed_permanently,
2340                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2341                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2342         }
2343 }
2344
2345 #[cfg(test)]
2346 macro_rules! expect_payment_failed {
2347         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2348                 #[allow(unused_mut)]
2349                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2350                 $(
2351                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2352                 )*
2353                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2354         };
2355 }
2356
2357 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2358         payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2359         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2360 ) {
2361         if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2362         let expected_payment_id = match &payment_failed_events[0] {
2363                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2364                         #[cfg(test)]
2365                         error_code,
2366                         #[cfg(test)]
2367                         error_data, .. } => {
2368                         assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2369                         assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2370                         #[cfg(test)]
2371                         {
2372                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2373                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2374                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
2375                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
2376                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2377                                 }
2378                         }
2379
2380                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2381                                 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2382                                         match upd {
2383                                                 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2384                                                         if let Some(scid) = conditions.expected_blamed_scid {
2385                                                                 assert_eq!(msg.contents.short_channel_id, scid);
2386                                                         }
2387                                                         const CHAN_DISABLED_FLAG: u8 = 2;
2388                                                         assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2389                                                 },
2390                                                 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2391                                                         if let Some(scid) = conditions.expected_blamed_scid {
2392                                                                 assert_eq!(*short_channel_id, scid);
2393                                                         }
2394                                                         assert!(is_permanent);
2395                                                 },
2396                                                 _ => panic!("Unexpected update type"),
2397                                         }
2398                                 } else { panic!("Expected network update"); }
2399                         }
2400
2401                         payment_id.unwrap()
2402                 },
2403                 _ => panic!("Unexpected event"),
2404         };
2405         if !conditions.expected_mpp_parts_remain {
2406                 match &payment_failed_events[1] {
2407                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2408                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2409                                 assert_eq!(*payment_id, expected_payment_id);
2410                                 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2411                                         PaymentFailureReason::RecipientRejected
2412                                 } else {
2413                                         PaymentFailureReason::RetriesExhausted
2414                                 });
2415                         }
2416                         _ => panic!("Unexpected second event"),
2417                 }
2418         }
2419 }
2420
2421 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2422         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2423         conditions: PaymentFailedConditions<'e>
2424 ) {
2425         let events = node.node.get_and_clear_pending_events();
2426         expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2427 }
2428
2429 pub fn send_along_route_with_secret<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_paths: &[&[&Node<'a, 'b, 'c>]], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: PaymentSecret) -> PaymentId {
2430         let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2431         origin_node.node.send_payment_with_route(&route, our_payment_hash,
2432                 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2433         check_added_monitors!(origin_node, expected_paths.len());
2434         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2435         payment_id
2436 }
2437
2438 fn fail_payment_along_path<'a, 'b, 'c>(expected_path: &[&Node<'a, 'b, 'c>]) {
2439         let origin_node_id = expected_path[0].node.get_our_node_id();
2440
2441         // iterate from the receiving node to the origin node and handle update fail htlc.
2442         for (&node, &prev_node) in expected_path.iter().rev().zip(expected_path.iter().rev().skip(1)) {
2443                 let updates = get_htlc_update_msgs!(node, prev_node.node.get_our_node_id());
2444                 prev_node.node.handle_update_fail_htlc(&node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2445                 check_added_monitors!(prev_node, 0);
2446
2447                 let is_first_hop = origin_node_id == prev_node.node.get_our_node_id();
2448                 // We do not want to fail backwards on the first hop. All other hops should fail backwards.
2449                 commitment_signed_dance!(prev_node, node, updates.commitment_signed, !is_first_hop);
2450         }
2451 }
2452
2453 pub fn do_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_claimable_expected: bool, clear_recipient_events: bool, expected_preimage: Option<PaymentPreimage>, is_probe: bool) -> Option<Event> {
2454         let mut payment_event = SendEvent::from_event(ev);
2455         let mut prev_node = origin_node;
2456         let mut event = None;
2457
2458         for (idx, &node) in expected_path.iter().enumerate() {
2459                 let is_last_hop = idx == expected_path.len() - 1;
2460                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2461
2462                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2463                 check_added_monitors!(node, 0);
2464
2465                 if is_last_hop && is_probe {
2466                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, true, true);
2467                 } else {
2468                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2469                         expect_pending_htlcs_forwardable!(node);
2470                 }
2471
2472                 if is_last_hop && clear_recipient_events {
2473                         let events_2 = node.node.get_and_clear_pending_events();
2474                         if payment_claimable_expected {
2475                                 assert_eq!(events_2.len(), 1);
2476                                 match &events_2[0] {
2477                                         Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2478                                                 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2479                                                 claim_deadline, onion_fields, ..
2480                                         } => {
2481                                                 assert_eq!(our_payment_hash, *payment_hash);
2482                                                 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2483                                                 assert!(onion_fields.is_some());
2484                                                 match &purpose {
2485                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2486                                                                 assert_eq!(expected_preimage, *payment_preimage);
2487                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2488                                                                 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2489                                                         },
2490                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2491                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2492                                                                 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2493                                                         },
2494                                                 }
2495                                                 assert_eq!(*amount_msat, recv_value);
2496                                                 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2497                                                 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2498                                                 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2499                                         },
2500                                         _ => panic!("Unexpected event"),
2501                                 }
2502                                 event = Some(events_2[0].clone());
2503                         } else {
2504                                 assert!(events_2.is_empty());
2505                         }
2506                 } else if !is_last_hop {
2507                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
2508                         assert_eq!(events_2.len(), 1);
2509                         check_added_monitors!(node, 1);
2510                         payment_event = SendEvent::from_event(events_2.remove(0));
2511                         assert_eq!(payment_event.msgs.len(), 1);
2512                 }
2513
2514                 prev_node = node;
2515         }
2516         event
2517 }
2518
2519 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_claimable_expected: bool, expected_preimage: Option<PaymentPreimage>) -> Option<Event> {
2520         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage, false)
2521 }
2522
2523 pub fn send_probe_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]]) {
2524         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2525         assert_eq!(events.len(), expected_route.len());
2526
2527         check_added_monitors!(origin_node, expected_route.len());
2528
2529         for path in expected_route.iter() {
2530                 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
2531
2532                 do_pass_along_path(origin_node, path, 0, PaymentHash([0_u8; 32]), None, ev, false, false, None, true);
2533                 let nodes_to_fail_payment: Vec<_> = vec![origin_node].into_iter().chain(path.iter().cloned()).collect();
2534
2535                 fail_payment_along_path(nodes_to_fail_payment.as_slice());
2536         }
2537 }
2538
2539 pub fn pass_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: PaymentSecret) {
2540         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2541         assert_eq!(events.len(), expected_route.len());
2542
2543         for (path_idx, expected_path) in expected_route.iter().enumerate() {
2544                 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2545                 // Once we've gotten through all the HTLCs, the last one should result in a
2546                 // PaymentClaimable (but each previous one should not!).
2547                 let expect_payment = path_idx == expected_route.len() - 1;
2548                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2549         }
2550 }
2551
2552 pub fn send_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
2553         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2554         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2555         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2556 }
2557
2558 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2559         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2560         our_payment_preimage: PaymentPreimage
2561 ) -> u64 {
2562         for path in expected_paths.iter() {
2563                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2564         }
2565         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2566         pass_claimed_payment_along_route(
2567                 ClaimAlongRouteArgs::new(origin_node, expected_paths, our_payment_preimage)
2568                         .skip_last(skip_last)
2569         )
2570 }
2571
2572 pub struct ClaimAlongRouteArgs<'a, 'b, 'c, 'd> {
2573         pub origin_node: &'a Node<'b, 'c, 'd>,
2574         pub expected_paths: &'a [&'a [&'a Node<'b, 'c, 'd>]],
2575         pub expected_extra_fees: Vec<u32>,
2576         pub expected_min_htlc_overpay: Vec<u32>,
2577         pub skip_last: bool,
2578         pub payment_preimage: PaymentPreimage,
2579 }
2580
2581 impl<'a, 'b, 'c, 'd> ClaimAlongRouteArgs<'a, 'b, 'c, 'd> {
2582         pub fn new(
2583                 origin_node: &'a Node<'b, 'c, 'd>, expected_paths: &'a [&'a [&'a Node<'b, 'c, 'd>]],
2584                 payment_preimage: PaymentPreimage,
2585         ) -> Self {
2586                 Self {
2587                         origin_node, expected_paths, expected_extra_fees: vec![0; expected_paths.len()],
2588                         expected_min_htlc_overpay: vec![0; expected_paths.len()], skip_last: false, payment_preimage,
2589                 }
2590         }
2591         pub fn skip_last(mut self, skip_last: bool) -> Self {
2592                 self.skip_last = skip_last;
2593                 self
2594         }
2595         pub fn with_expected_extra_fees(mut self, extra_fees: Vec<u32>) -> Self {
2596                 self.expected_extra_fees = extra_fees;
2597                 self
2598         }
2599         pub fn with_expected_min_htlc_overpay(mut self, extra_fees: Vec<u32>) -> Self {
2600                 self.expected_min_htlc_overpay = extra_fees;
2601                 self
2602         }
2603 }
2604
2605 pub fn pass_claimed_payment_along_route<'a, 'b, 'c, 'd>(args: ClaimAlongRouteArgs) -> u64 {
2606         let ClaimAlongRouteArgs {
2607                 origin_node, expected_paths, expected_extra_fees, expected_min_htlc_overpay, skip_last,
2608                 payment_preimage: our_payment_preimage
2609         } = args;
2610         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2611         assert_eq!(claim_event.len(), 1);
2612         match claim_event[0] {
2613                 Event::PaymentClaimed {
2614                         purpose: PaymentPurpose::SpontaneousPayment(preimage),
2615                         amount_msat,
2616                         ref htlcs,
2617                         .. }
2618                 | Event::PaymentClaimed {
2619                         purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2620                         ref htlcs,
2621                         amount_msat,
2622                         ..
2623                 } => {
2624                         assert_eq!(preimage, our_payment_preimage);
2625                         assert_eq!(htlcs.len(), expected_paths.len());  // One per path.
2626                         assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2627                         expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2628                 },
2629                 Event::PaymentClaimed {
2630                         purpose: PaymentPurpose::InvoicePayment { .. },
2631                         payment_hash,
2632                         amount_msat,
2633                         ref htlcs,
2634                         ..
2635                 } => {
2636                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2637                         assert_eq!(htlcs.len(), expected_paths.len());  // One per path.
2638                         assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2639                         expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2640                 }
2641                 _ => panic!(),
2642         }
2643
2644         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2645
2646         let mut expected_total_fee_msat = 0;
2647
2648         macro_rules! msgs_from_ev {
2649                 ($ev: expr) => {
2650                         match $ev {
2651                                 &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 } } => {
2652                                         assert!(update_add_htlcs.is_empty());
2653                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2654                                         assert!(update_fail_htlcs.is_empty());
2655                                         assert!(update_fail_malformed_htlcs.is_empty());
2656                                         assert!(update_fee.is_none());
2657                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2658                                 },
2659                                 _ => panic!("Unexpected event"),
2660                         }
2661                 }
2662         }
2663         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2664         let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2665         assert_eq!(events.len(), expected_paths.len());
2666
2667         if events.len() == 1 {
2668                 per_path_msgs.push(msgs_from_ev!(&events[0]));
2669         } else {
2670                 for expected_path in expected_paths.iter() {
2671                         // For MPP payments, we always want the message to the first node in the path.
2672                         let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2673                         per_path_msgs.push(msgs_from_ev!(&ev));
2674                 }
2675         }
2676
2677         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2678                 let mut next_msgs = Some(path_msgs);
2679                 let mut expected_next_node = next_hop;
2680
2681                 macro_rules! last_update_fulfill_dance {
2682                         ($node: expr, $prev_node: expr) => {
2683                                 {
2684                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2685                                         check_added_monitors!($node, 0);
2686                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2687                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2688                                 }
2689                         }
2690                 }
2691                 macro_rules! mid_update_fulfill_dance {
2692                         ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2693                                 {
2694                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2695                                         let mut fee = {
2696                                                 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2697                                                 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2698                                                         .unwrap().lock().unwrap();
2699                                                 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2700                                                 if let Some(prev_config) = channel.context().prev_config() {
2701                                                         prev_config.forwarding_fee_base_msat
2702                                                 } else {
2703                                                         channel.context().config().forwarding_fee_base_msat
2704                                                 }
2705                                         };
2706
2707                                         let mut expected_extra_fee = None;
2708                                         if $idx == 1 {
2709                                                 fee += expected_extra_fees[i];
2710                                                 fee += expected_min_htlc_overpay[i];
2711                                                 expected_extra_fee = if expected_extra_fees[i] > 0 { Some(expected_extra_fees[i] as u64) } else { None };
2712                                         }
2713                                         let mut events = $node.node.get_and_clear_pending_events();
2714                                         assert_eq!(events.len(), 1);
2715                                         expect_payment_forwarded(events.pop().unwrap(), *$node, $next_node, $prev_node,
2716                                                 Some(fee as u64), expected_extra_fee, false, false);
2717                                         expected_total_fee_msat += fee as u64;
2718                                         check_added_monitors!($node, 1);
2719                                         let new_next_msgs = if $new_msgs {
2720                                                 let events = $node.node.get_and_clear_pending_msg_events();
2721                                                 assert_eq!(events.len(), 1);
2722                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
2723                                                 expected_next_node = nexthop;
2724                                                 Some(res)
2725                                         } else {
2726                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2727                                                 None
2728                                         };
2729                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2730                                         next_msgs = new_next_msgs;
2731                                 }
2732                         }
2733                 }
2734
2735                 let mut prev_node = expected_route.last().unwrap();
2736                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2737                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2738                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2739                         if next_msgs.is_some() {
2740                                 // Since we are traversing in reverse, next_node is actually the previous node
2741                                 let next_node: &Node;
2742                                 if idx == expected_route.len() - 1 {
2743                                         next_node = origin_node;
2744                                 } else {
2745                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
2746                                 }
2747                                 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2748                         } else {
2749                                 assert!(!update_next_msgs);
2750                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2751                         }
2752                         if !skip_last && idx == expected_route.len() - 1 {
2753                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2754                         }
2755
2756                         prev_node = node;
2757                 }
2758
2759                 if !skip_last {
2760                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2761                 }
2762         }
2763
2764         // Ensure that claim_funds is idempotent.
2765         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2766         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2767         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2768
2769         expected_total_fee_msat
2770 }
2771 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) {
2772         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2773         if !skip_last {
2774                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2775         }
2776 }
2777
2778 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2779         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2780 }
2781
2782 pub const TEST_FINAL_CLTV: u32 = 70;
2783
2784 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
2785         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2786                 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2787         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2788         let route = get_route(origin_node, &route_params).unwrap();
2789         assert_eq!(route.paths.len(), 1);
2790         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2791         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2792                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2793         }
2794
2795         let res = send_along_route(origin_node, route, expected_route, recv_value);
2796         (res.0, res.1, res.2, res.3)
2797 }
2798
2799 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
2800         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2801                 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2802         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2803         let network_graph = origin_node.network_graph.read_only();
2804         let scorer = test_utils::TestScorer::new();
2805         let seed = [0u8; 32];
2806         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2807         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2808         let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2809                 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
2810         assert_eq!(route.paths.len(), 1);
2811         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2812         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2813                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2814         }
2815
2816         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2817         unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2818                         RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2819                 true, APIError::ChannelUnavailable { ref err },
2820                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2821 }
2822
2823 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
2824         let res = route_payment(&origin, expected_route, recv_value);
2825         claim_payment(&origin, expected_route, res.0);
2826         res
2827 }
2828
2829 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
2830         for path in expected_paths.iter() {
2831                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2832         }
2833         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2834         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2835         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2836
2837         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2838 }
2839
2840 pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
2841         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2842         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2843
2844         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2845         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2846         assert_eq!(events.len(), expected_paths.len());
2847         for ev in events.iter() {
2848                 let (update_fail, commitment_signed, node_id) = match ev {
2849                         &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 } } => {
2850                                 assert!(update_add_htlcs.is_empty());
2851                                 assert!(update_fulfill_htlcs.is_empty());
2852                                 assert_eq!(update_fail_htlcs.len(), 1);
2853                                 assert!(update_fail_malformed_htlcs.is_empty());
2854                                 assert!(update_fee.is_none());
2855                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2856                         },
2857                         _ => panic!("Unexpected event"),
2858                 };
2859                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2860         }
2861         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2862         expected_paths.sort_unstable_by(|path_a, path_b| path_a[path_a.len() - 2].node.get_our_node_id().cmp(&path_b[path_b.len() - 2].node.get_our_node_id()));
2863
2864         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2865                 let mut next_msgs = Some(path_msgs);
2866                 let mut expected_next_node = next_hop;
2867                 let mut prev_node = expected_route.last().unwrap();
2868
2869                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2870                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2871                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
2872                         if next_msgs.is_some() {
2873                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2874                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2875                                 if !update_next_node {
2876                                         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node, vec![HTLCDestination::NextHopChannel { node_id: Some(prev_node.node.get_our_node_id()), channel_id: next_msgs.as_ref().unwrap().0.channel_id }]);
2877                                 }
2878                         }
2879                         let events = node.node.get_and_clear_pending_msg_events();
2880                         if update_next_node {
2881                                 assert_eq!(events.len(), 1);
2882                                 match events[0] {
2883                                         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 } } => {
2884                                                 assert!(update_add_htlcs.is_empty());
2885                                                 assert!(update_fulfill_htlcs.is_empty());
2886                                                 assert_eq!(update_fail_htlcs.len(), 1);
2887                                                 assert!(update_fail_malformed_htlcs.is_empty());
2888                                                 assert!(update_fee.is_none());
2889                                                 expected_next_node = node_id.clone();
2890                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2891                                         },
2892                                         _ => panic!("Unexpected event"),
2893                                 }
2894                         } else {
2895                                 assert!(events.is_empty());
2896                         }
2897                         if !skip_last && idx == expected_route.len() - 1 {
2898                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2899                         }
2900
2901                         prev_node = node;
2902                 }
2903
2904                 if !skip_last {
2905                         let prev_node = expected_route.first().unwrap();
2906                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2907                         check_added_monitors!(origin_node, 0);
2908                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2909                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2910                         let events = origin_node.node.get_and_clear_pending_events();
2911                         if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2912
2913                         let expected_payment_id = match events[0] {
2914                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2915                                         assert_eq!(payment_hash, our_payment_hash);
2916                                         assert!(payment_failed_permanently);
2917                                         for (idx, hop) in expected_route.iter().enumerate() {
2918                                                 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2919                                         }
2920                                         payment_id.unwrap()
2921                                 },
2922                                 _ => panic!("Unexpected event"),
2923                         };
2924                         if i == expected_paths.len() - 1 {
2925                                 match events[1] {
2926                                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2927                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2928                                                 assert_eq!(*payment_id, expected_payment_id);
2929                                                 assert_eq!(reason.unwrap(), expected_fail_reason);
2930                                         }
2931                                         _ => panic!("Unexpected second event"),
2932                                 }
2933                         }
2934                 }
2935         }
2936
2937         // Ensure that fail_htlc_backwards is idempotent.
2938         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2939         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2940         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2941         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2942 }
2943
2944 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2945         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2946 }
2947
2948 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2949         let mut chan_mon_cfgs = Vec::new();
2950         for i in 0..node_count {
2951                 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2952                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2953                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2954                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2955                 let persister = test_utils::TestPersister::new();
2956                 let seed = [i as u8; 32];
2957                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2958                 let scorer = RwLock::new(test_utils::TestScorer::new());
2959
2960                 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2961         }
2962
2963         chan_mon_cfgs
2964 }
2965
2966 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2967         create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2968 }
2969
2970 pub fn create_node_cfgs_with_persisters<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>, persisters: Vec<&'a impl Persist<TestChannelSigner>>) -> Vec<NodeCfg<'a>> {
2971         let mut nodes = Vec::new();
2972
2973         for i in 0..node_count {
2974                 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, persisters[i], &chanmon_cfgs[i].keys_manager);
2975                 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2976                 let seed = [i as u8; 32];
2977                 nodes.push(NodeCfg {
2978                         chain_source: &chanmon_cfgs[i].chain_source,
2979                         logger: &chanmon_cfgs[i].logger,
2980                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2981                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2982                         router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].logger, &chanmon_cfgs[i].scorer),
2983                         message_router: test_utils::TestMessageRouter::new(network_graph.clone(), &chanmon_cfgs[i].keys_manager),
2984                         chain_monitor,
2985                         keys_manager: &chanmon_cfgs[i].keys_manager,
2986                         node_seed: seed,
2987                         network_graph,
2988                         override_init_features: Rc::new(RefCell::new(None)),
2989                 });
2990         }
2991
2992         nodes
2993 }
2994
2995 pub fn test_default_channel_config() -> UserConfig {
2996         let mut default_config = UserConfig::default();
2997         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2998         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2999         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
3000         default_config.channel_handshake_config.announced_channel = true;
3001         default_config.channel_handshake_limits.force_announced_channel_preference = false;
3002         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
3003         // It now defaults to 1, so we simply set it to the expected value here.
3004         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
3005         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
3006         // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
3007         // feerate of 253).
3008         default_config.channel_config.max_dust_htlc_exposure =
3009                 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
3010         default_config
3011 }
3012
3013 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<&'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'a test_utils::TestKeysInterface, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'b>, &'b test_utils::TestLogger>> {
3014         let mut chanmgrs = Vec::new();
3015         for i in 0..node_count {
3016                 let network = Network::Testnet;
3017                 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
3018                 let params = ChainParameters {
3019                         network,
3020                         best_block: BestBlock::from_network(network),
3021                 };
3022                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, &cfgs[i].router, cfgs[i].logger, cfgs[i].keys_manager,
3023                         cfgs[i].keys_manager, cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params, genesis_block.header.time);
3024                 chanmgrs.push(node);
3025         }
3026
3027         chanmgrs
3028 }
3029
3030 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<&'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestRouter, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
3031         let mut nodes = Vec::new();
3032         let chan_count = Rc::new(RefCell::new(0));
3033         let payment_count = Rc::new(RefCell::new(0));
3034         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
3035
3036         for i in 0..node_count {
3037                 let dedicated_entropy = DedicatedEntropy(RandomBytes::new([i as u8; 32]));
3038                 let onion_messenger = OnionMessenger::new(
3039                         dedicated_entropy, cfgs[i].keys_manager, cfgs[i].logger, &cfgs[i].message_router,
3040                         &chan_mgrs[i], IgnoringMessageHandler {},
3041                 );
3042                 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
3043                 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
3044                 nodes.push(Node{
3045                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
3046                         fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
3047                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
3048                         node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
3049                         node_seed: cfgs[i].node_seed, onion_messenger, network_chan_count: chan_count.clone(),
3050                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
3051                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
3052                         connect_style: Rc::clone(&connect_style),
3053                         override_init_features: Rc::clone(&cfgs[i].override_init_features),
3054                         wallet_source: Arc::clone(&wallet_source),
3055                         bump_tx_handler: BumpTransactionEventHandler::new(
3056                                 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
3057                                 &cfgs[i].keys_manager, cfgs[i].logger,
3058                         ),
3059                 })
3060         }
3061
3062         for i in 0..node_count {
3063                 for j in (i+1)..node_count {
3064                         let node_id_i = nodes[i].node.get_our_node_id();
3065                         let node_id_j = nodes[j].node.get_our_node_id();
3066
3067                         let init_i = msgs::Init {
3068                                 features: nodes[i].init_features(&node_id_j),
3069                                 networks: None,
3070                                 remote_network_address: None,
3071                         };
3072                         let init_j = msgs::Init {
3073                                 features: nodes[j].init_features(&node_id_i),
3074                                 networks: None,
3075                                 remote_network_address: None,
3076                         };
3077
3078                         nodes[i].node.peer_connected(&node_id_j, &init_j, true).unwrap();
3079                         nodes[j].node.peer_connected(&node_id_i, &init_i, false).unwrap();
3080                         nodes[i].onion_messenger.peer_connected(&node_id_j, &init_j, true).unwrap();
3081                         nodes[j].onion_messenger.peer_connected(&node_id_i, &init_i, false).unwrap();
3082                 }
3083         }
3084
3085         nodes
3086 }
3087
3088 // Note that the following only works for CLTV values up to 128
3089 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
3090 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
3091
3092 #[derive(PartialEq)]
3093 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
3094 /// Tests that the given node has broadcast transactions for the given Channel
3095 ///
3096 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
3097 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
3098 /// broadcast and the revoked outputs were claimed.
3099 ///
3100 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
3101 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
3102 ///
3103 /// All broadcast transactions must be accounted for in one of the above three types of we'll
3104 /// also fail.
3105 pub fn test_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction>  {
3106         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3107         let mut txn_seen = new_hash_set();
3108         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3109         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
3110
3111         let mut res = Vec::with_capacity(2);
3112         node_txn.retain(|tx| {
3113                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
3114                         check_spends!(tx, chan.3);
3115                         if commitment_tx.is_none() {
3116                                 res.push(tx.clone());
3117                         }
3118                         false
3119                 } else { true }
3120         });
3121         if let Some(explicit_tx) = commitment_tx {
3122                 res.push(explicit_tx.clone());
3123         }
3124
3125         assert_eq!(res.len(), 1);
3126
3127         if has_htlc_tx != HTLCType::NONE {
3128                 node_txn.retain(|tx| {
3129                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
3130                                 check_spends!(tx, res[0]);
3131                                 if has_htlc_tx == HTLCType::TIMEOUT {
3132                                         assert_ne!(tx.lock_time, LockTime::ZERO);
3133                                 } else {
3134                                         assert_eq!(tx.lock_time, LockTime::ZERO);
3135                                 }
3136                                 res.push(tx.clone());
3137                                 false
3138                         } else { true }
3139                 });
3140                 assert!(res.len() == 2 || res.len() == 3);
3141                 if res.len() == 3 {
3142                         assert_eq!(res[1], res[2]);
3143                 }
3144         }
3145
3146         assert!(node_txn.is_empty());
3147         res
3148 }
3149
3150 /// Tests that the given node has broadcast a claim transaction against the provided revoked
3151 /// HTLC transaction.
3152 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
3153         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3154         // We may issue multiple claiming transaction on revoked outputs due to block rescan
3155         // for revoked htlc outputs
3156         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
3157         node_txn.retain(|tx| {
3158                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
3159                         check_spends!(tx, revoked_tx);
3160                         false
3161                 } else { true }
3162         });
3163         node_txn.retain(|tx| {
3164                 check_spends!(tx, commitment_revoked_tx);
3165                 false
3166         });
3167         assert!(node_txn.is_empty());
3168 }
3169
3170 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
3171         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3172         let mut txn_seen = new_hash_set();
3173         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3174
3175         let mut found_prev = false;
3176         for prev_tx in prev_txn {
3177                 for tx in &*node_txn {
3178                         if tx.input[0].previous_output.txid == prev_tx.txid() {
3179                                 check_spends!(tx, prev_tx);
3180                                 let mut iter = tx.input[0].witness.iter();
3181                                 iter.next().expect("expected 3 witness items");
3182                                 iter.next().expect("expected 3 witness items");
3183                                 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
3184                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3185
3186                                 found_prev = true;
3187                                 break;
3188                         }
3189                 }
3190         }
3191         assert!(found_prev);
3192
3193         let mut res = Vec::new();
3194         mem::swap(&mut *node_txn, &mut res);
3195         res
3196 }
3197
3198 pub fn handle_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize, needs_err_handle: bool, expected_error: &str)  {
3199         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
3200         assert_eq!(events_1.len(), 2);
3201         let as_update = match events_1[0] {
3202                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3203                         msg.clone()
3204                 },
3205                 _ => panic!("Unexpected event"),
3206         };
3207         match events_1[1] {
3208                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3209                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
3210                         assert_eq!(msg.data, expected_error);
3211                         if needs_err_handle {
3212                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
3213                         }
3214                 },
3215                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3216                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
3217                         assert_eq!(msg.as_ref().unwrap().data, expected_error);
3218                         if needs_err_handle {
3219                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
3220                         }
3221                 },
3222                 _ => panic!("Unexpected event"),
3223         }
3224
3225         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
3226         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
3227         let bs_update = match events_2[0] {
3228                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3229                         msg.clone()
3230                 },
3231                 _ => panic!("Unexpected event"),
3232         };
3233         if !needs_err_handle {
3234                 match events_2[1] {
3235                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3236                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3237                                 assert_eq!(msg.data, expected_error);
3238                         },
3239                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3240                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3241                                 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3242                         },
3243                         _ => panic!("Unexpected event"),
3244                 }
3245         }
3246
3247         for node in nodes {
3248                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
3249                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
3250         }
3251 }
3252
3253 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
3254         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
3255 }
3256
3257 #[cfg(test)]
3258 macro_rules! get_channel_value_stat {
3259         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
3260                 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
3261                 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
3262                 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
3263                         |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
3264                 ).flatten().unwrap();
3265                 chan.get_value_stat()
3266         }}
3267 }
3268
3269 macro_rules! get_chan_reestablish_msgs {
3270         ($src_node: expr, $dst_node: expr) => {
3271                 {
3272                         let mut announcements = $crate::prelude::new_hash_set();
3273                         let mut res = Vec::with_capacity(1);
3274                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
3275                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3276                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3277                                         res.push(msg.clone());
3278                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
3279                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3280                                         announcements.insert(msg.contents.short_channel_id);
3281                                 } else {
3282                                         panic!("Unexpected event")
3283                                 }
3284                         }
3285                         assert!(announcements.is_empty());
3286                         res
3287                 }
3288         }
3289 }
3290
3291 macro_rules! handle_chan_reestablish_msgs {
3292         ($src_node: expr, $dst_node: expr) => {
3293                 {
3294                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3295                         let mut idx = 0;
3296                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3297                                 idx += 1;
3298                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3299                                 Some(msg.clone())
3300                         } else {
3301                                 None
3302                         };
3303
3304                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3305                                 idx += 1;
3306                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3307                         }
3308
3309                         let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3310                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3311                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3312                                 idx += 1;
3313                                 had_channel_update = true;
3314                         }
3315
3316                         let mut revoke_and_ack = None;
3317                         let mut commitment_update = None;
3318                         let order = if let Some(ev) = msg_events.get(idx) {
3319                                 match ev {
3320                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3321                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3322                                                 revoke_and_ack = Some(msg.clone());
3323                                                 idx += 1;
3324                                                 RAACommitmentOrder::RevokeAndACKFirst
3325                                         },
3326                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3327                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3328                                                 commitment_update = Some(updates.clone());
3329                                                 idx += 1;
3330                                                 RAACommitmentOrder::CommitmentFirst
3331                                         },
3332                                         _ => RAACommitmentOrder::CommitmentFirst,
3333                                 }
3334                         } else {
3335                                 RAACommitmentOrder::CommitmentFirst
3336                         };
3337
3338                         if let Some(ev) = msg_events.get(idx) {
3339                                 match ev {
3340                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3341                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3342                                                 assert!(revoke_and_ack.is_none());
3343                                                 revoke_and_ack = Some(msg.clone());
3344                                                 idx += 1;
3345                                         },
3346                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3347                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3348                                                 assert!(commitment_update.is_none());
3349                                                 commitment_update = Some(updates.clone());
3350                                                 idx += 1;
3351                                         },
3352                                         _ => {},
3353                                 }
3354                         }
3355
3356                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3357                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3358                                 idx += 1;
3359                                 assert!(!had_channel_update);
3360                         }
3361
3362                         assert_eq!(msg_events.len(), idx);
3363
3364                         (channel_ready, revoke_and_ack, commitment_update, order)
3365                 }
3366         }
3367 }
3368
3369 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3370         pub node_a: &'a Node<'b, 'c, 'd>,
3371         pub node_b: &'a Node<'b, 'c, 'd>,
3372         pub send_channel_ready: (bool, bool),
3373         pub pending_responding_commitment_signed: (bool, bool),
3374         /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3375         /// and no monitor update is expected
3376         pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3377         pub pending_htlc_adds: (usize, usize),
3378         pub pending_htlc_claims: (usize, usize),
3379         pub pending_htlc_fails: (usize, usize),
3380         pub pending_cell_htlc_claims: (usize, usize),
3381         pub pending_cell_htlc_fails: (usize, usize),
3382         pub pending_raa: (bool, bool),
3383 }
3384
3385 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3386         pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3387                 Self {
3388                         node_a,
3389                         node_b,
3390                         send_channel_ready: (false, false),
3391                         pending_responding_commitment_signed: (false, false),
3392                         pending_responding_commitment_signed_dup_monitor: (false, false),
3393                         pending_htlc_adds: (0, 0),
3394                         pending_htlc_claims: (0, 0),
3395                         pending_htlc_fails: (0, 0),
3396                         pending_cell_htlc_claims: (0, 0),
3397                         pending_cell_htlc_fails: (0, 0),
3398                         pending_raa: (false, false),
3399                 }
3400         }
3401 }
3402
3403 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3404 /// for claims/fails they are separated out.
3405 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3406         let ReconnectArgs {
3407                 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3408                 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3409                 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3410         } = args;
3411         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3412                 features: node_b.node.init_features(), networks: None, remote_network_address: None
3413         }, true).unwrap();
3414         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3415         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3416                 features: node_a.node.init_features(), networks: None, remote_network_address: None
3417         }, false).unwrap();
3418         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3419
3420         if send_channel_ready.0 {
3421                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3422                 // from b
3423                 for reestablish in reestablish_1.iter() {
3424                         let n = reestablish.next_remote_commitment_number;
3425                         assert_eq!(n, 0, "expected a->b next_remote_commitment_number to be 0, got {}", n);
3426                 }
3427         }
3428         if send_channel_ready.1 {
3429                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3430                 // from a
3431                 for reestablish in reestablish_2.iter() {
3432                         let n = reestablish.next_remote_commitment_number;
3433                         assert_eq!(n, 0, "expected b->a next_remote_commitment_number to be 0, got {}", n);
3434                 }
3435         }
3436         if send_channel_ready.0 || send_channel_ready.1 {
3437                 // If we expect any channel_ready's, both sides better have set
3438                 // next_holder_commitment_number to 1
3439                 for reestablish in reestablish_1.iter() {
3440                         let n = reestablish.next_local_commitment_number;
3441                         assert_eq!(n, 1, "expected a->b next_local_commitment_number to be 1, got {}", n);
3442                 }
3443                 for reestablish in reestablish_2.iter() {
3444                         let n = reestablish.next_local_commitment_number;
3445                         assert_eq!(n, 1, "expected b->a next_local_commitment_number to be 1, got {}", n);
3446                 }
3447         }
3448
3449         let mut resp_1 = Vec::new();
3450         for msg in reestablish_1 {
3451                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3452                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3453         }
3454         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3455                 check_added_monitors!(node_b, 1);
3456         } else {
3457                 check_added_monitors!(node_b, 0);
3458         }
3459
3460         let mut resp_2 = Vec::new();
3461         for msg in reestablish_2 {
3462                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3463                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3464         }
3465         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3466                 check_added_monitors!(node_a, 1);
3467         } else {
3468                 check_added_monitors!(node_a, 0);
3469         }
3470
3471         // We don't yet support both needing updates, as that would require a different commitment dance:
3472         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3473                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3474                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3475                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3476
3477         for chan_msgs in resp_1.drain(..) {
3478                 if send_channel_ready.0 {
3479                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3480                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3481                         if !announcement_event.is_empty() {
3482                                 assert_eq!(announcement_event.len(), 1);
3483                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3484                                         //TODO: Test announcement_sigs re-sending
3485                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3486                         }
3487                 } else {
3488                         assert!(chan_msgs.0.is_none());
3489                 }
3490                 if pending_raa.0 {
3491                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3492                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3493                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3494                         check_added_monitors!(node_a, 1);
3495                 } else {
3496                         assert!(chan_msgs.1.is_none());
3497                 }
3498                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3499                         pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3500                         pending_responding_commitment_signed.0
3501                 {
3502                         let commitment_update = chan_msgs.2.unwrap();
3503                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3504                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3505                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3506                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3507                         for update_add in commitment_update.update_add_htlcs {
3508                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3509                         }
3510                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3511                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3512                         }
3513                         for update_fail in commitment_update.update_fail_htlcs {
3514                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3515                         }
3516
3517                         if !pending_responding_commitment_signed.0 {
3518                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3519                         } else {
3520                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3521                                 check_added_monitors!(node_a, 1);
3522                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3523                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3524                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3525                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3526                                 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3527                         }
3528                 } else {
3529                         assert!(chan_msgs.2.is_none());
3530                 }
3531         }
3532
3533         for chan_msgs in resp_2.drain(..) {
3534                 if send_channel_ready.1 {
3535                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3536                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3537                         if !announcement_event.is_empty() {
3538                                 assert_eq!(announcement_event.len(), 1);
3539                                 match announcement_event[0] {
3540                                         MessageSendEvent::SendChannelUpdate { .. } => {},
3541                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3542                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3543                                 }
3544                         }
3545                 } else {
3546                         assert!(chan_msgs.0.is_none());
3547                 }
3548                 if pending_raa.1 {
3549                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3550                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3551                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3552                         check_added_monitors!(node_b, 1);
3553                 } else {
3554                         assert!(chan_msgs.1.is_none());
3555                 }
3556                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3557                         pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3558                         pending_responding_commitment_signed.1
3559                 {
3560                         let commitment_update = chan_msgs.2.unwrap();
3561                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3562                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3563                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3564                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3565                         for update_add in commitment_update.update_add_htlcs {
3566                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3567                         }
3568                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3569                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3570                         }
3571                         for update_fail in commitment_update.update_fail_htlcs {
3572                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3573                         }
3574
3575                         if !pending_responding_commitment_signed.1 {
3576                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3577                         } else {
3578                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3579                                 check_added_monitors!(node_b, 1);
3580                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3581                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3582                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3583                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3584                                 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3585                         }
3586                 } else {
3587                         assert!(chan_msgs.2.is_none());
3588                 }
3589         }
3590 }
3591
3592 /// Initiates channel opening and creates a single batch funding transaction.
3593 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3594 /// transaction with corresponding funding_created messages.
3595 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3596         funding_node: &Node<'a, 'b, 'c>,
3597         params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3598 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3599         let mut tx_outs = Vec::new();
3600         let mut temp_chan_ids = Vec::new();
3601         let mut funding_created_msgs = Vec::new();
3602
3603         for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3604                 // Initialize channel opening.
3605                 let temp_chan_id = funding_node.node.create_channel(
3606                         other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3607                         None,
3608                         *override_config,
3609                 ).unwrap();
3610                 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3611                 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3612                 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3613                 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3614
3615                 // Create the corresponding funding output.
3616                 let events = funding_node.node.get_and_clear_pending_events();
3617                 assert_eq!(events.len(), 1);
3618                 match events[0] {
3619                         Event::FundingGenerationReady {
3620                                 ref temporary_channel_id,
3621                                 ref counterparty_node_id,
3622                                 channel_value_satoshis: ref event_channel_value_satoshis,
3623                                 ref output_script,
3624                                 user_channel_id: ref event_user_channel_id
3625                         } => {
3626                                 assert_eq!(temporary_channel_id, &temp_chan_id);
3627                                 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3628                                 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3629                                 assert_eq!(user_channel_id, event_user_channel_id);
3630                                 tx_outs.push(TxOut {
3631                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3632                                 });
3633                         },
3634                         _ => panic!("Unexpected event"),
3635                 };
3636                 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3637         }
3638
3639         // Compose the batch funding transaction and give it to the ChannelManager.
3640         let tx = Transaction {
3641                 version: 2,
3642                 lock_time: LockTime::ZERO,
3643                 input: Vec::new(),
3644                 output: tx_outs,
3645         };
3646         assert!(funding_node.node.batch_funding_transaction_generated(
3647                 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3648                 tx.clone(),
3649         ).is_ok());
3650         check_added_monitors!(funding_node, 0);
3651         let events = funding_node.node.get_and_clear_pending_msg_events();
3652         assert_eq!(events.len(), params.len());
3653         for (other_node, ..) in params {
3654                 let funding_created = events
3655                         .iter()
3656                         .find_map(|event| match event {
3657                                 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3658                                 _ => None,
3659                         })
3660                         .unwrap();
3661                 funding_created_msgs.push(funding_created);
3662         }
3663         return (tx, funding_created_msgs);
3664 }