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