1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
11 use crate::chain::WatchedOutput;
12 use crate::chain::chaininterface;
13 use crate::chain::chaininterface::ConfirmationTarget;
14 use crate::chain::chaininterface::FEERATE_FLOOR_SATS_PER_KW;
15 use crate::chain::chainmonitor;
16 use crate::chain::chainmonitor::{MonitorUpdateId, UpdateOrigin};
17 use crate::chain::channelmonitor;
18 use crate::chain::channelmonitor::MonitorEvent;
19 use crate::chain::transaction::OutPoint;
22 use crate::events::bump_transaction::{WalletSource, Utxo};
23 use crate::ln::ChannelId;
24 use crate::ln::channelmanager;
25 use crate::ln::chan_utils::CommitmentTransaction;
26 use crate::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
27 use crate::ln::{msgs, wire};
28 use crate::ln::msgs::LightningError;
29 use crate::ln::script::ShutdownScript;
30 use crate::offers::invoice::UnsignedBolt12Invoice;
31 use crate::offers::invoice_request::UnsignedInvoiceRequest;
32 use crate::routing::gossip::{EffectiveCapacity, NetworkGraph, NodeId};
33 use crate::routing::utxo::{UtxoLookup, UtxoLookupError, UtxoResult};
34 use crate::routing::router::{find_route, InFlightHtlcs, Path, Route, RouteParameters, Router, ScorerAccountingForInFlightHtlcs};
35 use crate::routing::scoring::{ChannelUsage, ScoreUpdate, ScoreLookUp};
36 use crate::sync::RwLock;
37 use crate::util::config::UserConfig;
38 use crate::util::test_channel_signer::{TestChannelSigner, EnforcementState};
39 use crate::util::logger::{Logger, Level, Record};
40 use crate::util::ser::{Readable, ReadableArgs, Writer, Writeable};
41 use crate::util::persist::KVStore;
43 use bitcoin::EcdsaSighashType;
44 use bitcoin::blockdata::constants::ChainHash;
45 use bitcoin::blockdata::constants::genesis_block;
46 use bitcoin::blockdata::transaction::{Transaction, TxOut};
47 use bitcoin::blockdata::script::{Builder, Script};
48 use bitcoin::blockdata::opcodes;
49 use bitcoin::blockdata::block::Block;
50 use bitcoin::network::constants::Network;
51 use bitcoin::hash_types::{BlockHash, Txid};
52 use bitcoin::util::sighash::SighashCache;
54 use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey};
55 use bitcoin::secp256k1::ecdh::SharedSecret;
56 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
57 use bitcoin::secp256k1::schnorr;
59 #[cfg(any(test, feature = "_test_utils"))]
63 use crate::prelude::*;
64 use core::cell::RefCell;
65 use core::time::Duration;
66 use crate::sync::{Mutex, Arc};
67 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
69 use bitcoin::bech32::u5;
70 use crate::sign::{InMemorySigner, Recipient, EntropySource, NodeSigner, SignerProvider};
72 #[cfg(feature = "std")]
73 use std::time::{SystemTime, UNIX_EPOCH};
74 use bitcoin::Sequence;
76 pub fn pubkey(byte: u8) -> PublicKey {
77 let secp_ctx = Secp256k1::new();
78 PublicKey::from_secret_key(&secp_ctx, &privkey(byte))
81 pub fn privkey(byte: u8) -> SecretKey {
82 SecretKey::from_slice(&[byte; 32]).unwrap()
85 pub struct TestVecWriter(pub Vec<u8>);
86 impl Writer for TestVecWriter {
87 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
88 self.0.extend_from_slice(buf);
93 pub struct TestFeeEstimator {
94 pub sat_per_kw: Mutex<u32>,
96 impl chaininterface::FeeEstimator for TestFeeEstimator {
97 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
98 *self.sat_per_kw.lock().unwrap()
102 pub struct TestRouter<'a> {
103 pub network_graph: Arc<NetworkGraph<&'a TestLogger>>,
104 pub next_routes: Mutex<VecDeque<(RouteParameters, Result<Route, LightningError>)>>,
105 pub scorer: &'a RwLock<TestScorer>,
108 impl<'a> TestRouter<'a> {
109 pub fn new(network_graph: Arc<NetworkGraph<&'a TestLogger>>, scorer: &'a RwLock<TestScorer>) -> Self {
110 Self { network_graph, next_routes: Mutex::new(VecDeque::new()), scorer }
113 pub fn expect_find_route(&self, query: RouteParameters, result: Result<Route, LightningError>) {
114 let mut expected_routes = self.next_routes.lock().unwrap();
115 expected_routes.push_back((query, result));
119 impl<'a> Router for TestRouter<'a> {
121 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&channelmanager::ChannelDetails]>,
122 inflight_htlcs: InFlightHtlcs
123 ) -> Result<Route, msgs::LightningError> {
124 if let Some((find_route_query, find_route_res)) = self.next_routes.lock().unwrap().pop_front() {
125 assert_eq!(find_route_query, *params);
126 if let Ok(ref route) = find_route_res {
127 assert_eq!(route.route_params.as_ref().unwrap().final_value_msat, find_route_query.final_value_msat);
128 let scorer = self.scorer.read().unwrap();
129 let scorer = ScorerAccountingForInFlightHtlcs::new(scorer, &inflight_htlcs);
130 for path in &route.paths {
131 let mut aggregate_msat = 0u64;
132 for (idx, hop) in path.hops.iter().rev().enumerate() {
133 aggregate_msat += hop.fee_msat;
134 let usage = ChannelUsage {
135 amount_msat: aggregate_msat,
136 inflight_htlc_msat: 0,
137 effective_capacity: EffectiveCapacity::Unknown,
140 // Since the path is reversed, the last element in our iteration is the first
142 if idx == path.hops.len() - 1 {
143 scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(payer), &NodeId::from_pubkey(&hop.pubkey), usage, &Default::default());
145 let curr_hop_path_idx = path.hops.len() - 1 - idx;
146 scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(&path.hops[curr_hop_path_idx - 1].pubkey), &NodeId::from_pubkey(&hop.pubkey), usage, &Default::default());
151 return find_route_res;
153 let logger = TestLogger::new();
155 payer, params, &self.network_graph, first_hops, &logger,
156 &ScorerAccountingForInFlightHtlcs::new(self.scorer.read().unwrap(), &inflight_htlcs), &Default::default(),
162 impl<'a> Drop for TestRouter<'a> {
164 #[cfg(feature = "std")] {
165 if std::thread::panicking() {
169 assert!(self.next_routes.lock().unwrap().is_empty());
173 pub struct OnlyReadsKeysInterface {}
175 impl EntropySource for OnlyReadsKeysInterface {
176 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
178 impl SignerProvider for OnlyReadsKeysInterface {
179 type Signer = TestChannelSigner;
181 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
183 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::Signer { unreachable!(); }
185 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
186 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
187 let state = Arc::new(Mutex::new(EnforcementState::new()));
189 Ok(TestChannelSigner::new_with_revoked(
196 fn get_destination_script(&self) -> Result<Script, ()> { Err(()) }
197 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { Err(()) }
200 pub struct TestChainMonitor<'a> {
201 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<TestChannelSigner>)>>,
202 pub monitor_updates: Mutex<HashMap<ChannelId, Vec<channelmonitor::ChannelMonitorUpdate>>>,
203 pub latest_monitor_update_id: Mutex<HashMap<ChannelId, (OutPoint, u64, MonitorUpdateId)>>,
204 pub chain_monitor: chainmonitor::ChainMonitor<TestChannelSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a chainmonitor::Persist<TestChannelSigner>>,
205 pub keys_manager: &'a TestKeysInterface,
206 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
207 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
209 pub expect_channel_force_closed: Mutex<Option<(ChannelId, bool)>>,
210 /// If this is set to Some(), the next round trip serialization check will not hold after an
211 /// update_channel call (not watch_channel) for the given channel_id.
212 pub expect_monitor_round_trip_fail: Mutex<Option<ChannelId>>,
214 impl<'a> TestChainMonitor<'a> {
215 pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a chainmonitor::Persist<TestChannelSigner>, keys_manager: &'a TestKeysInterface) -> Self {
217 added_monitors: Mutex::new(Vec::new()),
218 monitor_updates: Mutex::new(HashMap::new()),
219 latest_monitor_update_id: Mutex::new(HashMap::new()),
220 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
222 expect_channel_force_closed: Mutex::new(None),
223 expect_monitor_round_trip_fail: Mutex::new(None),
227 pub fn complete_sole_pending_chan_update(&self, channel_id: &ChannelId) {
228 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
229 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
232 impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {
233 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
234 // At every point where we get a monitor update, we should be able to send a useful monitor
235 // to a watchtower and disk...
236 let mut w = TestVecWriter(Vec::new());
237 monitor.write(&mut w).unwrap();
238 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
239 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
240 assert!(new_monitor == monitor);
241 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
242 (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
243 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
244 self.chain_monitor.watch_channel(funding_txo, new_monitor)
247 fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
248 // Every monitor update should survive roundtrip
249 let mut w = TestVecWriter(Vec::new());
250 update.write(&mut w).unwrap();
251 assert!(channelmonitor::ChannelMonitorUpdate::read(
252 &mut io::Cursor::new(&w.0)).unwrap() == *update);
254 self.monitor_updates.lock().unwrap().entry(funding_txo.to_channel_id()).or_insert(Vec::new()).push(update.clone());
256 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
257 assert_eq!(funding_txo.to_channel_id(), exp.0);
258 assert_eq!(update.updates.len(), 1);
259 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
260 assert_eq!(should_broadcast, exp.1);
264 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
265 (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(update)));
266 let update_res = self.chain_monitor.update_channel(funding_txo, update);
267 // At every point where we get a monitor update, we should be able to send a useful monitor
268 // to a watchtower and disk...
269 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
271 monitor.write(&mut w).unwrap();
272 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
273 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
274 if let Some(chan_id) = self.expect_monitor_round_trip_fail.lock().unwrap().take() {
275 assert_eq!(chan_id, funding_txo.to_channel_id());
276 assert!(new_monitor != *monitor);
278 assert!(new_monitor == *monitor);
280 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
284 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
285 return self.chain_monitor.release_pending_monitor_events();
289 struct JusticeTxData {
290 justice_tx: Transaction,
292 commitment_number: u64,
295 pub(crate) struct WatchtowerPersister {
296 persister: TestPersister,
297 /// Upon a new commitment_signed, we'll get a
298 /// ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTxInfo. We'll store the justice tx
299 /// amount, and commitment number so we can build the justice tx after our counterparty
301 unsigned_justice_tx_data: Mutex<HashMap<OutPoint, VecDeque<JusticeTxData>>>,
302 /// After receiving a revoke_and_ack for a commitment number, we'll form and store the justice
303 /// tx which would be used to provide a watchtower with the data it needs.
304 watchtower_state: Mutex<HashMap<OutPoint, HashMap<Txid, Transaction>>>,
305 destination_script: Script,
308 impl WatchtowerPersister {
310 pub(crate) fn new(destination_script: Script) -> Self {
311 WatchtowerPersister {
312 persister: TestPersister::new(),
313 unsigned_justice_tx_data: Mutex::new(HashMap::new()),
314 watchtower_state: Mutex::new(HashMap::new()),
320 pub(crate) fn justice_tx(&self, funding_txo: OutPoint, commitment_txid: &Txid)
321 -> Option<Transaction> {
322 self.watchtower_state.lock().unwrap().get(&funding_txo).unwrap().get(commitment_txid).cloned()
325 fn form_justice_data_from_commitment(&self, counterparty_commitment_tx: &CommitmentTransaction)
326 -> Option<JusticeTxData> {
327 let trusted_tx = counterparty_commitment_tx.trust();
328 let output_idx = trusted_tx.revokeable_output_index()?;
329 let built_tx = trusted_tx.built_transaction();
330 let value = built_tx.transaction.output[output_idx as usize].value;
331 let justice_tx = trusted_tx.build_to_local_justice_tx(
332 FEERATE_FLOOR_SATS_PER_KW as u64, self.destination_script.clone()).ok()?;
333 let commitment_number = counterparty_commitment_tx.commitment_number();
334 Some(JusticeTxData { justice_tx, value, commitment_number })
338 impl<Signer: sign::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for WatchtowerPersister {
339 fn persist_new_channel(&self, funding_txo: OutPoint,
340 data: &channelmonitor::ChannelMonitor<Signer>, id: MonitorUpdateId
341 ) -> chain::ChannelMonitorUpdateStatus {
342 let res = self.persister.persist_new_channel(funding_txo, data, id);
344 assert!(self.unsigned_justice_tx_data.lock().unwrap()
345 .insert(funding_txo, VecDeque::new()).is_none());
346 assert!(self.watchtower_state.lock().unwrap()
347 .insert(funding_txo, HashMap::new()).is_none());
349 let initial_counterparty_commitment_tx = data.initial_counterparty_commitment_tx()
350 .expect("First and only call expects Some");
351 if let Some(justice_data)
352 = self.form_justice_data_from_commitment(&initial_counterparty_commitment_tx) {
353 self.unsigned_justice_tx_data.lock().unwrap()
354 .get_mut(&funding_txo).unwrap()
355 .push_back(justice_data);
360 fn update_persisted_channel(
361 &self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>,
362 data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId
363 ) -> chain::ChannelMonitorUpdateStatus {
364 let res = self.persister.update_persisted_channel(funding_txo, update, data, update_id);
366 if let Some(update) = update {
367 let commitment_txs = data.counterparty_commitment_txs_from_update(update);
368 let justice_datas = commitment_txs.into_iter()
369 .filter_map(|commitment_tx| self.form_justice_data_from_commitment(&commitment_tx));
370 let mut channels_justice_txs = self.unsigned_justice_tx_data.lock().unwrap();
371 let channel_state = channels_justice_txs.get_mut(&funding_txo).unwrap();
372 channel_state.extend(justice_datas);
374 while let Some(JusticeTxData { justice_tx, value, commitment_number }) = channel_state.front() {
376 let commitment_txid = justice_tx.input[input_idx].previous_output.txid;
377 match data.sign_to_local_justice_tx(justice_tx.clone(), input_idx, *value, *commitment_number) {
378 Ok(signed_justice_tx) => {
379 let dup = self.watchtower_state.lock().unwrap()
380 .get_mut(&funding_txo).unwrap()
381 .insert(commitment_txid, signed_justice_tx);
382 assert!(dup.is_none());
383 channel_state.pop_front();
393 pub struct TestPersister {
394 /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
396 pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
397 /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
398 /// MonitorUpdateId here.
399 pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
400 /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
401 /// MonitorUpdateId here.
402 pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
405 pub fn new() -> Self {
407 update_rets: Mutex::new(VecDeque::new()),
408 chain_sync_monitor_persistences: Mutex::new(HashMap::new()),
409 offchain_monitor_updates: Mutex::new(HashMap::new()),
413 /// Queue an update status to return.
414 pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
415 self.update_rets.lock().unwrap().push_back(next_ret);
418 impl<Signer: sign::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
419 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
420 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
423 chain::ChannelMonitorUpdateStatus::Completed
426 fn update_persisted_channel(&self, funding_txo: OutPoint, _update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
427 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
428 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
431 let is_chain_sync = if let UpdateOrigin::ChainSync(_) = update_id.contents { true } else { false };
433 self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
435 self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
441 pub struct TestStore {
442 persisted_bytes: Mutex<HashMap<String, HashMap<String, Vec<u8>>>>,
447 pub fn new(read_only: bool) -> Self {
448 let persisted_bytes = Mutex::new(HashMap::new());
449 Self { persisted_bytes, read_only }
453 impl KVStore for TestStore {
454 fn read(&self, primary_namespace: &str, secondary_namespace: &str, key: &str) -> io::Result<Vec<u8>> {
455 let persisted_lock = self.persisted_bytes.lock().unwrap();
456 let prefixed = if secondary_namespace.is_empty() {
457 primary_namespace.to_string()
459 format!("{}/{}", primary_namespace, secondary_namespace)
462 if let Some(outer_ref) = persisted_lock.get(&prefixed) {
463 if let Some(inner_ref) = outer_ref.get(key) {
464 let bytes = inner_ref.clone();
467 Err(io::Error::new(io::ErrorKind::NotFound, "Key not found"))
470 Err(io::Error::new(io::ErrorKind::NotFound, "Namespace not found"))
474 fn write(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: &[u8]) -> io::Result<()> {
476 return Err(io::Error::new(
477 io::ErrorKind::PermissionDenied,
478 "Cannot modify read-only store",
481 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
483 let prefixed = if secondary_namespace.is_empty() {
484 primary_namespace.to_string()
486 format!("{}/{}", primary_namespace, secondary_namespace)
488 let outer_e = persisted_lock.entry(prefixed).or_insert(HashMap::new());
489 let mut bytes = Vec::new();
490 bytes.write_all(buf)?;
491 outer_e.insert(key.to_string(), bytes);
495 fn remove(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, _lazy: bool) -> io::Result<()> {
497 return Err(io::Error::new(
498 io::ErrorKind::PermissionDenied,
499 "Cannot modify read-only store",
503 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
505 let prefixed = if secondary_namespace.is_empty() {
506 primary_namespace.to_string()
508 format!("{}/{}", primary_namespace, secondary_namespace)
510 if let Some(outer_ref) = persisted_lock.get_mut(&prefixed) {
511 outer_ref.remove(&key.to_string());
517 fn list(&self, primary_namespace: &str, secondary_namespace: &str) -> io::Result<Vec<String>> {
518 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
520 let prefixed = if secondary_namespace.is_empty() {
521 primary_namespace.to_string()
523 format!("{}/{}", primary_namespace, secondary_namespace)
525 match persisted_lock.entry(prefixed) {
526 hash_map::Entry::Occupied(e) => Ok(e.get().keys().cloned().collect()),
527 hash_map::Entry::Vacant(_) => Ok(Vec::new()),
532 pub struct TestBroadcaster {
533 pub txn_broadcasted: Mutex<Vec<Transaction>>,
534 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
537 impl TestBroadcaster {
538 pub fn new(network: Network) -> Self {
540 txn_broadcasted: Mutex::new(Vec::new()),
541 blocks: Arc::new(Mutex::new(vec![(genesis_block(network), 0)])),
545 pub fn with_blocks(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> Self {
546 Self { txn_broadcasted: Mutex::new(Vec::new()), blocks }
549 pub fn txn_broadcast(&self) -> Vec<Transaction> {
550 self.txn_broadcasted.lock().unwrap().split_off(0)
553 pub fn unique_txn_broadcast(&self) -> Vec<Transaction> {
554 let mut txn = self.txn_broadcasted.lock().unwrap().split_off(0);
555 let mut seen = HashSet::new();
556 txn.retain(|tx| seen.insert(tx.txid()));
561 impl chaininterface::BroadcasterInterface for TestBroadcaster {
562 fn broadcast_transactions(&self, txs: &[&Transaction]) {
564 let lock_time = tx.lock_time.0;
565 assert!(lock_time < 1_500_000_000);
566 if bitcoin::LockTime::from(tx.lock_time).is_block_height() && lock_time > self.blocks.lock().unwrap().last().unwrap().1 {
567 for inp in tx.input.iter() {
568 if inp.sequence != Sequence::MAX {
569 panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
574 let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
575 self.txn_broadcasted.lock().unwrap().extend(owned_txs);
579 pub struct TestChannelMessageHandler {
580 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
581 expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
582 connected_peers: Mutex<HashSet<PublicKey>>,
583 pub message_fetch_counter: AtomicUsize,
584 genesis_hash: ChainHash,
587 impl TestChannelMessageHandler {
588 pub fn new(genesis_hash: ChainHash) -> Self {
589 TestChannelMessageHandler {
590 pending_events: Mutex::new(Vec::new()),
591 expected_recv_msgs: Mutex::new(None),
592 connected_peers: Mutex::new(HashSet::new()),
593 message_fetch_counter: AtomicUsize::new(0),
599 pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
600 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
601 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
602 expected_msgs.as_mut().unwrap().push(ev);
605 fn received_msg(&self, _ev: wire::Message<()>) {
606 let mut msgs = self.expected_recv_msgs.lock().unwrap();
607 if msgs.is_none() { return; }
608 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
610 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
611 msgs.as_mut().unwrap().remove(0);
615 impl Drop for TestChannelMessageHandler {
617 #[cfg(feature = "std")]
619 let l = self.expected_recv_msgs.lock().unwrap();
620 if !std::thread::panicking() {
621 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
627 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
628 fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
629 self.received_msg(wire::Message::OpenChannel(msg.clone()));
631 fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
632 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
634 fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
635 self.received_msg(wire::Message::FundingCreated(msg.clone()));
637 fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
638 self.received_msg(wire::Message::FundingSigned(msg.clone()));
640 fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
641 self.received_msg(wire::Message::ChannelReady(msg.clone()));
643 fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
644 self.received_msg(wire::Message::Shutdown(msg.clone()));
646 fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
647 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
649 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
650 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
652 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
653 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
655 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
656 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
658 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
659 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
661 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
662 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
664 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
665 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
667 fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
668 self.received_msg(wire::Message::UpdateFee(msg.clone()));
670 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
671 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
673 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
674 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
676 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
677 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
679 fn peer_disconnected(&self, their_node_id: &PublicKey) {
680 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
682 fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
683 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
684 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
685 // bother re-generating the expected Init message in all tests.
688 fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
689 self.received_msg(wire::Message::Error(msg.clone()));
691 fn provided_node_features(&self) -> NodeFeatures {
692 channelmanager::provided_node_features(&UserConfig::default())
694 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
695 channelmanager::provided_init_features(&UserConfig::default())
698 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
699 Some(vec![self.genesis_hash])
702 fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
703 self.received_msg(wire::Message::OpenChannelV2(msg.clone()));
706 fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
707 self.received_msg(wire::Message::AcceptChannelV2(msg.clone()));
710 fn handle_tx_add_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
711 self.received_msg(wire::Message::TxAddInput(msg.clone()));
714 fn handle_tx_add_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
715 self.received_msg(wire::Message::TxAddOutput(msg.clone()));
718 fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
719 self.received_msg(wire::Message::TxRemoveInput(msg.clone()));
722 fn handle_tx_remove_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
723 self.received_msg(wire::Message::TxRemoveOutput(msg.clone()));
726 fn handle_tx_complete(&self, _their_node_id: &PublicKey, msg: &msgs::TxComplete) {
727 self.received_msg(wire::Message::TxComplete(msg.clone()));
730 fn handle_tx_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
731 self.received_msg(wire::Message::TxSignatures(msg.clone()));
734 fn handle_tx_init_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
735 self.received_msg(wire::Message::TxInitRbf(msg.clone()));
738 fn handle_tx_ack_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
739 self.received_msg(wire::Message::TxAckRbf(msg.clone()));
742 fn handle_tx_abort(&self, _their_node_id: &PublicKey, msg: &msgs::TxAbort) {
743 self.received_msg(wire::Message::TxAbort(msg.clone()));
747 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
748 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
749 self.message_fetch_counter.fetch_add(1, Ordering::AcqRel);
750 let mut pending_events = self.pending_events.lock().unwrap();
751 let mut ret = Vec::new();
752 mem::swap(&mut ret, &mut *pending_events);
757 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
758 use bitcoin::secp256k1::ffi::Signature as FFISignature;
759 let secp_ctx = Secp256k1::new();
760 let network = Network::Testnet;
761 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
762 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
763 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
764 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
765 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
766 features: ChannelFeatures::empty(),
767 chain_hash: genesis_block(network).header.block_hash(),
768 short_channel_id: short_chan_id,
769 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
770 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
771 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
772 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
773 excess_data: Vec::new(),
777 msgs::ChannelAnnouncement {
778 node_signature_1: Signature::from(FFISignature::new()),
779 node_signature_2: Signature::from(FFISignature::new()),
780 bitcoin_signature_1: Signature::from(FFISignature::new()),
781 bitcoin_signature_2: Signature::from(FFISignature::new()),
782 contents: unsigned_ann,
787 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
788 use bitcoin::secp256k1::ffi::Signature as FFISignature;
789 let network = Network::Testnet;
790 msgs::ChannelUpdate {
791 signature: Signature::from(unsafe { FFISignature::new() }),
792 contents: msgs::UnsignedChannelUpdate {
793 chain_hash: genesis_block(network).header.block_hash(),
794 short_channel_id: short_chan_id,
797 cltv_expiry_delta: 0,
798 htlc_minimum_msat: 0,
799 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
801 fee_proportional_millionths: 0,
807 pub struct TestRoutingMessageHandler {
808 pub chan_upds_recvd: AtomicUsize,
809 pub chan_anns_recvd: AtomicUsize,
810 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
811 pub request_full_sync: AtomicBool,
814 impl TestRoutingMessageHandler {
815 pub fn new() -> Self {
816 TestRoutingMessageHandler {
817 chan_upds_recvd: AtomicUsize::new(0),
818 chan_anns_recvd: AtomicUsize::new(0),
819 pending_events: Mutex::new(vec![]),
820 request_full_sync: AtomicBool::new(false),
824 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
825 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
826 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
828 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
829 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
830 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
832 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
833 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
834 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
836 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
837 let chan_upd_1 = get_dummy_channel_update(starting_point);
838 let chan_upd_2 = get_dummy_channel_update(starting_point);
839 let chan_ann = get_dummy_channel_announcement(starting_point);
841 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
844 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
848 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
849 if !init_msg.features.supports_gossip_queries() {
853 #[allow(unused_mut, unused_assignments)]
854 let mut gossip_start_time = 0;
855 #[cfg(feature = "std")]
857 gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
858 if self.request_full_sync.load(Ordering::Acquire) {
859 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
861 gossip_start_time -= 60 * 60; // an hour ago
865 let mut pending_events = self.pending_events.lock().unwrap();
866 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
867 node_id: their_node_id.clone(),
868 msg: msgs::GossipTimestampFilter {
869 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
870 first_timestamp: gossip_start_time as u32,
871 timestamp_range: u32::max_value(),
877 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
881 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
885 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
889 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
893 fn provided_node_features(&self) -> NodeFeatures {
894 let mut features = NodeFeatures::empty();
895 features.set_gossip_queries_optional();
899 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
900 let mut features = InitFeatures::empty();
901 features.set_gossip_queries_optional();
905 fn processing_queue_high(&self) -> bool { false }
908 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
909 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
910 let mut ret = Vec::new();
911 let mut pending_events = self.pending_events.lock().unwrap();
912 core::mem::swap(&mut ret, &mut pending_events);
917 pub struct TestLogger {
919 pub(crate) id: String,
920 pub lines: Mutex<HashMap<(String, String), usize>>,
924 pub fn new() -> TestLogger {
925 Self::with_id("".to_owned())
927 pub fn with_id(id: String) -> TestLogger {
931 lines: Mutex::new(HashMap::new())
934 pub fn enable(&mut self, level: Level) {
937 pub fn assert_log(&self, module: String, line: String, count: usize) {
938 let log_entries = self.lines.lock().unwrap();
939 assert_eq!(log_entries.get(&(module, line)), Some(&count));
942 /// Search for the number of occurrence of the logged lines which
943 /// 1. belongs to the specified module and
944 /// 2. contains `line` in it.
945 /// And asserts if the number of occurrences is the same with the given `count`
946 pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
947 let log_entries = self.lines.lock().unwrap();
948 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
949 m == module && l.contains(line)
950 }).map(|(_, c) | { c }).sum();
954 /// Search for the number of occurrences of logged lines which
955 /// 1. belong to the specified module and
956 /// 2. match the given regex pattern.
957 /// Assert that the number of occurrences equals the given `count`
958 #[cfg(any(test, feature = "_test_utils"))]
959 pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
960 let log_entries = self.lines.lock().unwrap();
961 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
962 m == module && pattern.is_match(&l)
963 }).map(|(_, c) | { c }).sum();
968 impl Logger for TestLogger {
969 fn log(&self, record: &Record) {
970 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
971 if record.level >= self.level {
972 #[cfg(all(not(ldk_bench), feature = "std"))]
973 println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
978 pub struct TestNodeSigner {
979 node_secret: SecretKey,
982 impl TestNodeSigner {
983 pub fn new(node_secret: SecretKey) -> Self {
988 impl NodeSigner for TestNodeSigner {
989 fn get_inbound_payment_key_material(&self) -> crate::sign::KeyMaterial {
993 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
994 let node_secret = match recipient {
995 Recipient::Node => Ok(&self.node_secret),
996 Recipient::PhantomNode => Err(())
998 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
1001 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
1002 let mut node_secret = match recipient {
1003 Recipient::Node => Ok(self.node_secret.clone()),
1004 Recipient::PhantomNode => Err(())
1006 if let Some(tweak) = tweak {
1007 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1009 Ok(SharedSecret::new(other_key, &node_secret))
1012 fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
1016 fn sign_bolt12_invoice_request(
1017 &self, _invoice_request: &UnsignedInvoiceRequest
1018 ) -> Result<schnorr::Signature, ()> {
1022 fn sign_bolt12_invoice(
1023 &self, _invoice: &UnsignedBolt12Invoice,
1024 ) -> Result<schnorr::Signature, ()> {
1028 fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1033 pub struct TestKeysInterface {
1034 pub backing: sign::PhantomKeysManager,
1035 pub override_random_bytes: Mutex<Option<[u8; 32]>>,
1036 pub disable_revocation_policy_check: bool,
1037 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
1038 expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
1041 impl EntropySource for TestKeysInterface {
1042 fn get_secure_random_bytes(&self) -> [u8; 32] {
1043 let override_random_bytes = self.override_random_bytes.lock().unwrap();
1044 if let Some(bytes) = &*override_random_bytes {
1047 self.backing.get_secure_random_bytes()
1051 impl NodeSigner for TestKeysInterface {
1052 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1053 self.backing.get_node_id(recipient)
1056 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1057 self.backing.ecdh(recipient, other_key, tweak)
1060 fn get_inbound_payment_key_material(&self) -> sign::KeyMaterial {
1061 self.backing.get_inbound_payment_key_material()
1064 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1065 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
1068 fn sign_bolt12_invoice_request(
1069 &self, invoice_request: &UnsignedInvoiceRequest
1070 ) -> Result<schnorr::Signature, ()> {
1071 self.backing.sign_bolt12_invoice_request(invoice_request)
1074 fn sign_bolt12_invoice(
1075 &self, invoice: &UnsignedBolt12Invoice,
1076 ) -> Result<schnorr::Signature, ()> {
1077 self.backing.sign_bolt12_invoice(invoice)
1080 fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1081 self.backing.sign_gossip_message(msg)
1085 impl SignerProvider for TestKeysInterface {
1086 type Signer = TestChannelSigner;
1088 fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1089 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1092 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> TestChannelSigner {
1093 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
1094 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1095 TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
1098 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
1099 let mut reader = io::Cursor::new(buffer);
1101 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
1102 let state = self.make_enforcement_state_cell(inner.commitment_seed);
1104 Ok(TestChannelSigner::new_with_revoked(
1107 self.disable_revocation_policy_check
1111 fn get_destination_script(&self) -> Result<Script, ()> { self.backing.get_destination_script() }
1113 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1114 match &mut *self.expectations.lock().unwrap() {
1115 None => self.backing.get_shutdown_scriptpubkey(),
1116 Some(expectations) => match expectations.pop_front() {
1117 None => panic!("Unexpected get_shutdown_scriptpubkey"),
1118 Some(expectation) => Ok(expectation.returns),
1124 impl TestKeysInterface {
1125 pub fn new(seed: &[u8; 32], network: Network) -> Self {
1126 let now = Duration::from_secs(genesis_block(network).header.time as u64);
1128 backing: sign::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
1129 override_random_bytes: Mutex::new(None),
1130 disable_revocation_policy_check: false,
1131 enforcement_states: Mutex::new(HashMap::new()),
1132 expectations: Mutex::new(None),
1136 /// Sets an expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] is
1138 pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
1139 self.expectations.lock().unwrap()
1140 .get_or_insert_with(|| VecDeque::new())
1141 .push_back(expectation);
1145 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> TestChannelSigner {
1146 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
1147 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1148 TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
1151 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
1152 let mut states = self.enforcement_states.lock().unwrap();
1153 if !states.contains_key(&commitment_seed) {
1154 let state = EnforcementState::new();
1155 states.insert(commitment_seed, Arc::new(Mutex::new(state)));
1157 let cell = states.get(&commitment_seed).unwrap();
1162 pub(crate) fn panicking() -> bool {
1163 #[cfg(feature = "std")]
1164 let panicking = ::std::thread::panicking();
1165 #[cfg(not(feature = "std"))]
1166 let panicking = false;
1170 impl Drop for TestKeysInterface {
1171 fn drop(&mut self) {
1176 if let Some(expectations) = &*self.expectations.lock().unwrap() {
1177 if !expectations.is_empty() {
1178 panic!("Unsatisfied expectations: {:?}", expectations);
1184 /// An expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] was called and
1185 /// returns a [`ShutdownScript`].
1186 pub struct OnGetShutdownScriptpubkey {
1187 /// A shutdown script used to close a channel.
1188 pub returns: ShutdownScript,
1191 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
1192 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
1193 f.debug_struct("OnGetShutdownScriptpubkey").finish()
1197 pub struct TestChainSource {
1198 pub genesis_hash: BlockHash,
1199 pub utxo_ret: Mutex<UtxoResult>,
1200 pub get_utxo_call_count: AtomicUsize,
1201 pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
1202 pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
1205 impl TestChainSource {
1206 pub fn new(network: Network) -> Self {
1207 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1209 genesis_hash: genesis_block(network).block_hash(),
1210 utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
1211 get_utxo_call_count: AtomicUsize::new(0),
1212 watched_txn: Mutex::new(HashSet::new()),
1213 watched_outputs: Mutex::new(HashSet::new()),
1218 impl UtxoLookup for TestChainSource {
1219 fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> UtxoResult {
1220 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
1221 if self.genesis_hash != *genesis_hash {
1222 return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
1225 self.utxo_ret.lock().unwrap().clone()
1229 impl chain::Filter for TestChainSource {
1230 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
1231 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
1234 fn register_output(&self, output: WatchedOutput) {
1235 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
1239 impl Drop for TestChainSource {
1240 fn drop(&mut self) {
1247 pub struct TestScorer {
1248 /// Stores a tuple of (scid, ChannelUsage)
1249 scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
1253 pub fn new() -> Self {
1255 scorer_expectations: RefCell::new(None),
1259 pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
1260 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
1265 impl crate::util::ser::Writeable for TestScorer {
1266 fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
1269 impl ScoreLookUp for TestScorer {
1270 type ScoreParams = ();
1271 fn channel_penalty_msat(
1272 &self, short_channel_id: u64, _source: &NodeId, _target: &NodeId, usage: ChannelUsage, _score_params: &Self::ScoreParams
1274 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
1275 match scorer_expectations.pop_front() {
1276 Some((scid, expectation)) => {
1277 assert_eq!(expectation, usage);
1278 assert_eq!(scid, short_channel_id);
1287 impl ScoreUpdate for TestScorer {
1288 fn payment_path_failed(&mut self, _actual_path: &Path, _actual_short_channel_id: u64) {}
1290 fn payment_path_successful(&mut self, _actual_path: &Path) {}
1292 fn probe_failed(&mut self, _actual_path: &Path, _: u64) {}
1294 fn probe_successful(&mut self, _actual_path: &Path) {}
1297 impl Drop for TestScorer {
1298 fn drop(&mut self) {
1299 #[cfg(feature = "std")] {
1300 if std::thread::panicking() {
1305 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
1306 if !scorer_expectations.is_empty() {
1307 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
1313 pub struct TestWalletSource {
1314 secret_key: SecretKey,
1315 utxos: RefCell<Vec<Utxo>>,
1316 secp: Secp256k1<bitcoin::secp256k1::All>,
1319 impl TestWalletSource {
1320 pub fn new(secret_key: SecretKey) -> Self {
1323 utxos: RefCell::new(Vec::new()),
1324 secp: Secp256k1::new(),
1328 pub fn add_utxo(&self, outpoint: bitcoin::OutPoint, value: u64) -> TxOut {
1329 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1330 let utxo = Utxo::new_p2pkh(outpoint, value, &public_key.pubkey_hash());
1331 self.utxos.borrow_mut().push(utxo.clone());
1335 pub fn add_custom_utxo(&self, utxo: Utxo) -> TxOut {
1336 let output = utxo.output.clone();
1337 self.utxos.borrow_mut().push(utxo);
1341 pub fn remove_utxo(&self, outpoint: bitcoin::OutPoint) {
1342 self.utxos.borrow_mut().retain(|utxo| utxo.outpoint != outpoint);
1346 impl WalletSource for TestWalletSource {
1347 fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()> {
1348 Ok(self.utxos.borrow().clone())
1351 fn get_change_script(&self) -> Result<Script, ()> {
1352 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1353 Ok(Script::new_p2pkh(&public_key.pubkey_hash()))
1356 fn sign_tx(&self, mut tx: Transaction) -> Result<Transaction, ()> {
1357 let utxos = self.utxos.borrow();
1358 for i in 0..tx.input.len() {
1359 if let Some(utxo) = utxos.iter().find(|utxo| utxo.outpoint == tx.input[i].previous_output) {
1360 let sighash = SighashCache::new(&tx)
1361 .legacy_signature_hash(i, &utxo.output.script_pubkey, EcdsaSighashType::All as u32)
1363 let sig = self.secp.sign_ecdsa(&sighash.as_hash().into(), &self.secret_key);
1364 let bitcoin_sig = bitcoin::EcdsaSig { sig, hash_ty: EcdsaSighashType::All }.to_vec();
1365 tx.input[i].script_sig = Builder::new()
1366 .push_slice(&bitcoin_sig)
1367 .push_slice(&self.secret_key.public_key(&self.secp).serialize())