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;
20 use crate::routing::router::CandidateRouteHop;
23 use crate::events::bump_transaction::{WalletSource, Utxo};
24 use crate::ln::ChannelId;
25 use crate::ln::channelmanager;
26 use crate::ln::chan_utils::CommitmentTransaction;
27 use crate::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
28 use crate::ln::{msgs, wire};
29 use crate::ln::msgs::LightningError;
30 use crate::ln::script::ShutdownScript;
31 use crate::offers::invoice::UnsignedBolt12Invoice;
32 use crate::offers::invoice_request::UnsignedInvoiceRequest;
33 use crate::routing::gossip::{EffectiveCapacity, NetworkGraph, NodeId};
34 use crate::routing::utxo::{UtxoLookup, UtxoLookupError, UtxoResult};
35 use crate::routing::router::{find_route, InFlightHtlcs, Path, Route, RouteParameters, Router, ScorerAccountingForInFlightHtlcs};
36 use crate::routing::scoring::{ChannelUsage, ScoreUpdate, ScoreLookUp};
37 use crate::sync::RwLock;
38 use crate::util::config::UserConfig;
39 use crate::util::test_channel_signer::{TestChannelSigner, EnforcementState};
40 use crate::util::logger::{Logger, Level, Record};
41 use crate::util::ser::{Readable, ReadableArgs, Writer, Writeable};
42 use crate::util::persist::KVStore;
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, ScriptBuf};
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::sighash::{SighashCache, EcdsaSighashType};
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, Some(find_route_query));
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 let first_hops = match first_hops {
147 if first_hops.len() == 0 {
150 let idx = if first_hops.len() > 1 { route.paths.iter().position(|p| p == path).unwrap_or(0) } else { 0 };
151 let candidate = CandidateRouteHop::FirstHop {
152 details: first_hops[idx],
153 node_id: NodeId::from_pubkey(payer)
155 scorer.channel_penalty_msat(&candidate, usage, &());
157 let network_graph = self.network_graph.read_only();
158 let channel = match network_graph.channel(hop.short_channel_id) {
159 Some(channel) => channel,
162 let channel = match channel.as_directed_to(&NodeId::from_pubkey(&hop.pubkey)) {
163 Some(channel) => channel,
164 None => panic!("Channel directed to {} was not found", hop.pubkey),
166 let candidate = CandidateRouteHop::PublicHop {
168 short_channel_id: hop.short_channel_id,
170 scorer.channel_penalty_msat(&candidate, usage, &());
175 return find_route_res;
177 let logger = TestLogger::new();
179 payer, params, &self.network_graph, first_hops, &logger,
180 &ScorerAccountingForInFlightHtlcs::new(self.scorer.read().unwrap(), &inflight_htlcs), &Default::default(),
186 impl<'a> Drop for TestRouter<'a> {
188 #[cfg(feature = "std")] {
189 if std::thread::panicking() {
193 assert!(self.next_routes.lock().unwrap().is_empty());
197 pub struct OnlyReadsKeysInterface {}
199 impl EntropySource for OnlyReadsKeysInterface {
200 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
202 impl SignerProvider for OnlyReadsKeysInterface {
203 type EcdsaSigner = TestChannelSigner;
205 type TaprootSigner = TestChannelSigner;
207 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
209 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner { unreachable!(); }
211 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
212 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
213 let state = Arc::new(Mutex::new(EnforcementState::new()));
215 Ok(TestChannelSigner::new_with_revoked(
222 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { Err(()) }
223 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { Err(()) }
226 pub struct TestChainMonitor<'a> {
227 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<TestChannelSigner>)>>,
228 pub monitor_updates: Mutex<HashMap<ChannelId, Vec<channelmonitor::ChannelMonitorUpdate>>>,
229 pub latest_monitor_update_id: Mutex<HashMap<ChannelId, (OutPoint, u64, MonitorUpdateId)>>,
230 pub chain_monitor: chainmonitor::ChainMonitor<TestChannelSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a chainmonitor::Persist<TestChannelSigner>>,
231 pub keys_manager: &'a TestKeysInterface,
232 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
233 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
235 pub expect_channel_force_closed: Mutex<Option<(ChannelId, bool)>>,
236 /// If this is set to Some(), the next round trip serialization check will not hold after an
237 /// update_channel call (not watch_channel) for the given channel_id.
238 pub expect_monitor_round_trip_fail: Mutex<Option<ChannelId>>,
240 impl<'a> TestChainMonitor<'a> {
241 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 {
243 added_monitors: Mutex::new(Vec::new()),
244 monitor_updates: Mutex::new(HashMap::new()),
245 latest_monitor_update_id: Mutex::new(HashMap::new()),
246 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
248 expect_channel_force_closed: Mutex::new(None),
249 expect_monitor_round_trip_fail: Mutex::new(None),
253 pub fn complete_sole_pending_chan_update(&self, channel_id: &ChannelId) {
254 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
255 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
258 impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {
259 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
260 // At every point where we get a monitor update, we should be able to send a useful monitor
261 // to a watchtower and disk...
262 let mut w = TestVecWriter(Vec::new());
263 monitor.write(&mut w).unwrap();
264 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
265 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
266 assert!(new_monitor == monitor);
267 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
268 (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
269 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
270 self.chain_monitor.watch_channel(funding_txo, new_monitor)
273 fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
274 // Every monitor update should survive roundtrip
275 let mut w = TestVecWriter(Vec::new());
276 update.write(&mut w).unwrap();
277 assert!(channelmonitor::ChannelMonitorUpdate::read(
278 &mut io::Cursor::new(&w.0)).unwrap() == *update);
280 self.monitor_updates.lock().unwrap().entry(funding_txo.to_channel_id()).or_insert(Vec::new()).push(update.clone());
282 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
283 assert_eq!(funding_txo.to_channel_id(), exp.0);
284 assert_eq!(update.updates.len(), 1);
285 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
286 assert_eq!(should_broadcast, exp.1);
290 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
291 (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(update)));
292 let update_res = self.chain_monitor.update_channel(funding_txo, update);
293 // At every point where we get a monitor update, we should be able to send a useful monitor
294 // to a watchtower and disk...
295 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
297 monitor.write(&mut w).unwrap();
298 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
299 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
300 if let Some(chan_id) = self.expect_monitor_round_trip_fail.lock().unwrap().take() {
301 assert_eq!(chan_id, funding_txo.to_channel_id());
302 assert!(new_monitor != *monitor);
304 assert!(new_monitor == *monitor);
306 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
310 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
311 return self.chain_monitor.release_pending_monitor_events();
315 struct JusticeTxData {
316 justice_tx: Transaction,
318 commitment_number: u64,
321 pub(crate) struct WatchtowerPersister {
322 persister: TestPersister,
323 /// Upon a new commitment_signed, we'll get a
324 /// ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTxInfo. We'll store the justice tx
325 /// amount, and commitment number so we can build the justice tx after our counterparty
327 unsigned_justice_tx_data: Mutex<HashMap<OutPoint, VecDeque<JusticeTxData>>>,
328 /// After receiving a revoke_and_ack for a commitment number, we'll form and store the justice
329 /// tx which would be used to provide a watchtower with the data it needs.
330 watchtower_state: Mutex<HashMap<OutPoint, HashMap<Txid, Transaction>>>,
331 destination_script: ScriptBuf,
334 impl WatchtowerPersister {
336 pub(crate) fn new(destination_script: ScriptBuf) -> Self {
337 WatchtowerPersister {
338 persister: TestPersister::new(),
339 unsigned_justice_tx_data: Mutex::new(HashMap::new()),
340 watchtower_state: Mutex::new(HashMap::new()),
346 pub(crate) fn justice_tx(&self, funding_txo: OutPoint, commitment_txid: &Txid)
347 -> Option<Transaction> {
348 self.watchtower_state.lock().unwrap().get(&funding_txo).unwrap().get(commitment_txid).cloned()
351 fn form_justice_data_from_commitment(&self, counterparty_commitment_tx: &CommitmentTransaction)
352 -> Option<JusticeTxData> {
353 let trusted_tx = counterparty_commitment_tx.trust();
354 let output_idx = trusted_tx.revokeable_output_index()?;
355 let built_tx = trusted_tx.built_transaction();
356 let value = built_tx.transaction.output[output_idx as usize].value;
357 let justice_tx = trusted_tx.build_to_local_justice_tx(
358 FEERATE_FLOOR_SATS_PER_KW as u64, self.destination_script.clone()).ok()?;
359 let commitment_number = counterparty_commitment_tx.commitment_number();
360 Some(JusticeTxData { justice_tx, value, commitment_number })
364 impl<Signer: sign::ecdsa::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for WatchtowerPersister {
365 fn persist_new_channel(&self, funding_txo: OutPoint,
366 data: &channelmonitor::ChannelMonitor<Signer>, id: MonitorUpdateId
367 ) -> chain::ChannelMonitorUpdateStatus {
368 let res = self.persister.persist_new_channel(funding_txo, data, id);
370 assert!(self.unsigned_justice_tx_data.lock().unwrap()
371 .insert(funding_txo, VecDeque::new()).is_none());
372 assert!(self.watchtower_state.lock().unwrap()
373 .insert(funding_txo, HashMap::new()).is_none());
375 let initial_counterparty_commitment_tx = data.initial_counterparty_commitment_tx()
376 .expect("First and only call expects Some");
377 if let Some(justice_data)
378 = self.form_justice_data_from_commitment(&initial_counterparty_commitment_tx) {
379 self.unsigned_justice_tx_data.lock().unwrap()
380 .get_mut(&funding_txo).unwrap()
381 .push_back(justice_data);
386 fn update_persisted_channel(
387 &self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>,
388 data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId
389 ) -> chain::ChannelMonitorUpdateStatus {
390 let res = self.persister.update_persisted_channel(funding_txo, update, data, update_id);
392 if let Some(update) = update {
393 let commitment_txs = data.counterparty_commitment_txs_from_update(update);
394 let justice_datas = commitment_txs.into_iter()
395 .filter_map(|commitment_tx| self.form_justice_data_from_commitment(&commitment_tx));
396 let mut channels_justice_txs = self.unsigned_justice_tx_data.lock().unwrap();
397 let channel_state = channels_justice_txs.get_mut(&funding_txo).unwrap();
398 channel_state.extend(justice_datas);
400 while let Some(JusticeTxData { justice_tx, value, commitment_number }) = channel_state.front() {
402 let commitment_txid = justice_tx.input[input_idx].previous_output.txid;
403 match data.sign_to_local_justice_tx(justice_tx.clone(), input_idx, *value, *commitment_number) {
404 Ok(signed_justice_tx) => {
405 let dup = self.watchtower_state.lock().unwrap()
406 .get_mut(&funding_txo).unwrap()
407 .insert(commitment_txid, signed_justice_tx);
408 assert!(dup.is_none());
409 channel_state.pop_front();
419 pub struct TestPersister {
420 /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
422 pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
423 /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
424 /// MonitorUpdateId here.
425 pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
426 /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
427 /// MonitorUpdateId here.
428 pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
431 pub fn new() -> Self {
433 update_rets: Mutex::new(VecDeque::new()),
434 chain_sync_monitor_persistences: Mutex::new(HashMap::new()),
435 offchain_monitor_updates: Mutex::new(HashMap::new()),
439 /// Queue an update status to return.
440 pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
441 self.update_rets.lock().unwrap().push_back(next_ret);
444 impl<Signer: sign::ecdsa::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
445 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
446 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
449 chain::ChannelMonitorUpdateStatus::Completed
452 fn update_persisted_channel(&self, funding_txo: OutPoint, _update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
453 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
454 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
457 let is_chain_sync = if let UpdateOrigin::ChainSync(_) = update_id.contents { true } else { false };
459 self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
461 self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
467 pub struct TestStore {
468 persisted_bytes: Mutex<HashMap<String, HashMap<String, Vec<u8>>>>,
473 pub fn new(read_only: bool) -> Self {
474 let persisted_bytes = Mutex::new(HashMap::new());
475 Self { persisted_bytes, read_only }
479 impl KVStore for TestStore {
480 fn read(&self, primary_namespace: &str, secondary_namespace: &str, key: &str) -> io::Result<Vec<u8>> {
481 let persisted_lock = self.persisted_bytes.lock().unwrap();
482 let prefixed = if secondary_namespace.is_empty() {
483 primary_namespace.to_string()
485 format!("{}/{}", primary_namespace, secondary_namespace)
488 if let Some(outer_ref) = persisted_lock.get(&prefixed) {
489 if let Some(inner_ref) = outer_ref.get(key) {
490 let bytes = inner_ref.clone();
493 Err(io::Error::new(io::ErrorKind::NotFound, "Key not found"))
496 Err(io::Error::new(io::ErrorKind::NotFound, "Namespace not found"))
500 fn write(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: &[u8]) -> io::Result<()> {
502 return Err(io::Error::new(
503 io::ErrorKind::PermissionDenied,
504 "Cannot modify read-only store",
507 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
509 let prefixed = if secondary_namespace.is_empty() {
510 primary_namespace.to_string()
512 format!("{}/{}", primary_namespace, secondary_namespace)
514 let outer_e = persisted_lock.entry(prefixed).or_insert(HashMap::new());
515 let mut bytes = Vec::new();
516 bytes.write_all(buf)?;
517 outer_e.insert(key.to_string(), bytes);
521 fn remove(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, _lazy: bool) -> io::Result<()> {
523 return Err(io::Error::new(
524 io::ErrorKind::PermissionDenied,
525 "Cannot modify read-only store",
529 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
531 let prefixed = if secondary_namespace.is_empty() {
532 primary_namespace.to_string()
534 format!("{}/{}", primary_namespace, secondary_namespace)
536 if let Some(outer_ref) = persisted_lock.get_mut(&prefixed) {
537 outer_ref.remove(&key.to_string());
543 fn list(&self, primary_namespace: &str, secondary_namespace: &str) -> io::Result<Vec<String>> {
544 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
546 let prefixed = if secondary_namespace.is_empty() {
547 primary_namespace.to_string()
549 format!("{}/{}", primary_namespace, secondary_namespace)
551 match persisted_lock.entry(prefixed) {
552 hash_map::Entry::Occupied(e) => Ok(e.get().keys().cloned().collect()),
553 hash_map::Entry::Vacant(_) => Ok(Vec::new()),
558 pub struct TestBroadcaster {
559 pub txn_broadcasted: Mutex<Vec<Transaction>>,
560 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
563 impl TestBroadcaster {
564 pub fn new(network: Network) -> Self {
566 txn_broadcasted: Mutex::new(Vec::new()),
567 blocks: Arc::new(Mutex::new(vec![(genesis_block(network), 0)])),
571 pub fn with_blocks(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> Self {
572 Self { txn_broadcasted: Mutex::new(Vec::new()), blocks }
575 pub fn txn_broadcast(&self) -> Vec<Transaction> {
576 self.txn_broadcasted.lock().unwrap().split_off(0)
579 pub fn unique_txn_broadcast(&self) -> Vec<Transaction> {
580 let mut txn = self.txn_broadcasted.lock().unwrap().split_off(0);
581 let mut seen = HashSet::new();
582 txn.retain(|tx| seen.insert(tx.txid()));
587 impl chaininterface::BroadcasterInterface for TestBroadcaster {
588 fn broadcast_transactions(&self, txs: &[&Transaction]) {
590 let lock_time = tx.lock_time.to_consensus_u32();
591 assert!(lock_time < 1_500_000_000);
592 if tx.lock_time.is_block_height() && lock_time > self.blocks.lock().unwrap().last().unwrap().1 {
593 for inp in tx.input.iter() {
594 if inp.sequence != Sequence::MAX {
595 panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
600 let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
601 self.txn_broadcasted.lock().unwrap().extend(owned_txs);
605 pub struct TestChannelMessageHandler {
606 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
607 expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
608 connected_peers: Mutex<HashSet<PublicKey>>,
609 pub message_fetch_counter: AtomicUsize,
610 chain_hash: ChainHash,
613 impl TestChannelMessageHandler {
614 pub fn new(chain_hash: ChainHash) -> Self {
615 TestChannelMessageHandler {
616 pending_events: Mutex::new(Vec::new()),
617 expected_recv_msgs: Mutex::new(None),
618 connected_peers: Mutex::new(HashSet::new()),
619 message_fetch_counter: AtomicUsize::new(0),
625 pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
626 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
627 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
628 expected_msgs.as_mut().unwrap().push(ev);
631 fn received_msg(&self, _ev: wire::Message<()>) {
632 let mut msgs = self.expected_recv_msgs.lock().unwrap();
633 if msgs.is_none() { return; }
634 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
636 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
637 msgs.as_mut().unwrap().remove(0);
641 impl Drop for TestChannelMessageHandler {
643 #[cfg(feature = "std")]
645 let l = self.expected_recv_msgs.lock().unwrap();
646 if !std::thread::panicking() {
647 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
653 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
654 fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
655 self.received_msg(wire::Message::OpenChannel(msg.clone()));
657 fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
658 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
660 fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
661 self.received_msg(wire::Message::FundingCreated(msg.clone()));
663 fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
664 self.received_msg(wire::Message::FundingSigned(msg.clone()));
666 fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
667 self.received_msg(wire::Message::ChannelReady(msg.clone()));
669 fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
670 self.received_msg(wire::Message::Shutdown(msg.clone()));
672 fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
673 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
675 fn handle_stfu(&self, _their_node_id: &PublicKey, msg: &msgs::Stfu) {
676 self.received_msg(wire::Message::Stfu(msg.clone()));
678 fn handle_splice(&self, _their_node_id: &PublicKey, msg: &msgs::Splice) {
679 self.received_msg(wire::Message::Splice(msg.clone()));
681 fn handle_splice_ack(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
682 self.received_msg(wire::Message::SpliceAck(msg.clone()));
684 fn handle_splice_locked(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
685 self.received_msg(wire::Message::SpliceLocked(msg.clone()));
687 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
688 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
690 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
691 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
693 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
694 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
696 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
697 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
699 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
700 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
702 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
703 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
705 fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
706 self.received_msg(wire::Message::UpdateFee(msg.clone()));
708 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
709 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
711 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
712 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
714 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
715 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
717 fn peer_disconnected(&self, their_node_id: &PublicKey) {
718 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
720 fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
721 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
722 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
723 // bother re-generating the expected Init message in all tests.
726 fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
727 self.received_msg(wire::Message::Error(msg.clone()));
729 fn provided_node_features(&self) -> NodeFeatures {
730 channelmanager::provided_node_features(&UserConfig::default())
732 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
733 channelmanager::provided_init_features(&UserConfig::default())
736 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
737 Some(vec![self.chain_hash])
740 fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
741 self.received_msg(wire::Message::OpenChannelV2(msg.clone()));
744 fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
745 self.received_msg(wire::Message::AcceptChannelV2(msg.clone()));
748 fn handle_tx_add_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
749 self.received_msg(wire::Message::TxAddInput(msg.clone()));
752 fn handle_tx_add_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
753 self.received_msg(wire::Message::TxAddOutput(msg.clone()));
756 fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
757 self.received_msg(wire::Message::TxRemoveInput(msg.clone()));
760 fn handle_tx_remove_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
761 self.received_msg(wire::Message::TxRemoveOutput(msg.clone()));
764 fn handle_tx_complete(&self, _their_node_id: &PublicKey, msg: &msgs::TxComplete) {
765 self.received_msg(wire::Message::TxComplete(msg.clone()));
768 fn handle_tx_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
769 self.received_msg(wire::Message::TxSignatures(msg.clone()));
772 fn handle_tx_init_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
773 self.received_msg(wire::Message::TxInitRbf(msg.clone()));
776 fn handle_tx_ack_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
777 self.received_msg(wire::Message::TxAckRbf(msg.clone()));
780 fn handle_tx_abort(&self, _their_node_id: &PublicKey, msg: &msgs::TxAbort) {
781 self.received_msg(wire::Message::TxAbort(msg.clone()));
785 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
786 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
787 self.message_fetch_counter.fetch_add(1, Ordering::AcqRel);
788 let mut pending_events = self.pending_events.lock().unwrap();
789 let mut ret = Vec::new();
790 mem::swap(&mut ret, &mut *pending_events);
795 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
796 use bitcoin::secp256k1::ffi::Signature as FFISignature;
797 let secp_ctx = Secp256k1::new();
798 let network = Network::Testnet;
799 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
800 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
801 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
802 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
803 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
804 features: ChannelFeatures::empty(),
805 chain_hash: ChainHash::using_genesis_block(network),
806 short_channel_id: short_chan_id,
807 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
808 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
809 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
810 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
811 excess_data: Vec::new(),
815 msgs::ChannelAnnouncement {
816 node_signature_1: Signature::from(FFISignature::new()),
817 node_signature_2: Signature::from(FFISignature::new()),
818 bitcoin_signature_1: Signature::from(FFISignature::new()),
819 bitcoin_signature_2: Signature::from(FFISignature::new()),
820 contents: unsigned_ann,
825 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
826 use bitcoin::secp256k1::ffi::Signature as FFISignature;
827 let network = Network::Testnet;
828 msgs::ChannelUpdate {
829 signature: Signature::from(unsafe { FFISignature::new() }),
830 contents: msgs::UnsignedChannelUpdate {
831 chain_hash: ChainHash::using_genesis_block(network),
832 short_channel_id: short_chan_id,
835 cltv_expiry_delta: 0,
836 htlc_minimum_msat: 0,
837 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
839 fee_proportional_millionths: 0,
845 pub struct TestRoutingMessageHandler {
846 pub chan_upds_recvd: AtomicUsize,
847 pub chan_anns_recvd: AtomicUsize,
848 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
849 pub request_full_sync: AtomicBool,
852 impl TestRoutingMessageHandler {
853 pub fn new() -> Self {
854 TestRoutingMessageHandler {
855 chan_upds_recvd: AtomicUsize::new(0),
856 chan_anns_recvd: AtomicUsize::new(0),
857 pending_events: Mutex::new(vec![]),
858 request_full_sync: AtomicBool::new(false),
862 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
863 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
864 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
866 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
867 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
868 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
870 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
871 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
872 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
874 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
875 let chan_upd_1 = get_dummy_channel_update(starting_point);
876 let chan_upd_2 = get_dummy_channel_update(starting_point);
877 let chan_ann = get_dummy_channel_announcement(starting_point);
879 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
882 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
886 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
887 if !init_msg.features.supports_gossip_queries() {
891 #[allow(unused_mut, unused_assignments)]
892 let mut gossip_start_time = 0;
893 #[cfg(feature = "std")]
895 gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
896 if self.request_full_sync.load(Ordering::Acquire) {
897 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
899 gossip_start_time -= 60 * 60; // an hour ago
903 let mut pending_events = self.pending_events.lock().unwrap();
904 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
905 node_id: their_node_id.clone(),
906 msg: msgs::GossipTimestampFilter {
907 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
908 first_timestamp: gossip_start_time as u32,
909 timestamp_range: u32::max_value(),
915 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
919 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
923 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
927 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
931 fn provided_node_features(&self) -> NodeFeatures {
932 let mut features = NodeFeatures::empty();
933 features.set_gossip_queries_optional();
937 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
938 let mut features = InitFeatures::empty();
939 features.set_gossip_queries_optional();
943 fn processing_queue_high(&self) -> bool { false }
946 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
947 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
948 let mut ret = Vec::new();
949 let mut pending_events = self.pending_events.lock().unwrap();
950 core::mem::swap(&mut ret, &mut pending_events);
955 pub struct TestLogger {
957 pub(crate) id: String,
958 pub lines: Mutex<HashMap<(&'static str, String), usize>>,
959 pub context: Mutex<HashMap<(&'static str, Option<PublicKey>, Option<ChannelId>), usize>>,
963 pub fn new() -> TestLogger {
964 Self::with_id("".to_owned())
966 pub fn with_id(id: String) -> TestLogger {
970 lines: Mutex::new(HashMap::new()),
971 context: Mutex::new(HashMap::new()),
974 pub fn enable(&mut self, level: Level) {
977 pub fn assert_log(&self, module: &str, line: String, count: usize) {
978 let log_entries = self.lines.lock().unwrap();
979 assert_eq!(log_entries.get(&(module, line)), Some(&count));
982 /// Search for the number of occurrence of the logged lines which
983 /// 1. belongs to the specified module and
984 /// 2. contains `line` in it.
985 /// And asserts if the number of occurrences is the same with the given `count`
986 pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
987 let log_entries = self.lines.lock().unwrap();
988 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
989 *m == module && l.contains(line)
990 }).map(|(_, c) | { c }).sum();
994 /// Search for the number of occurrences of logged lines which
995 /// 1. belong to the specified module and
996 /// 2. match the given regex pattern.
997 /// Assert that the number of occurrences equals the given `count`
998 #[cfg(any(test, feature = "_test_utils"))]
999 pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
1000 let log_entries = self.lines.lock().unwrap();
1001 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1002 *m == module && pattern.is_match(&l)
1003 }).map(|(_, c) | { c }).sum();
1004 assert_eq!(l, count)
1007 pub fn assert_log_context_contains(
1008 &self, module: &str, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>, count: usize
1010 let context_entries = self.context.lock().unwrap();
1011 let l = context_entries.get(&(module, peer_id, channel_id)).unwrap();
1012 assert_eq!(*l, count)
1016 impl Logger for TestLogger {
1017 fn log(&self, record: Record) {
1018 *self.lines.lock().unwrap().entry((record.module_path, format!("{}", record.args))).or_insert(0) += 1;
1019 *self.context.lock().unwrap().entry((record.module_path, record.peer_id, record.channel_id)).or_insert(0) += 1;
1020 if record.level >= self.level {
1021 #[cfg(all(not(ldk_bench), feature = "std"))] {
1022 let pfx = format!("{} {} [{}:{}]", self.id, record.level.to_string(), record.module_path, record.line);
1023 println!("{:<55}{}", pfx, record.args);
1029 pub struct TestNodeSigner {
1030 node_secret: SecretKey,
1033 impl TestNodeSigner {
1034 pub fn new(node_secret: SecretKey) -> Self {
1035 Self { node_secret }
1039 impl NodeSigner for TestNodeSigner {
1040 fn get_inbound_payment_key_material(&self) -> crate::sign::KeyMaterial {
1044 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1045 let node_secret = match recipient {
1046 Recipient::Node => Ok(&self.node_secret),
1047 Recipient::PhantomNode => Err(())
1049 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
1052 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
1053 let mut node_secret = match recipient {
1054 Recipient::Node => Ok(self.node_secret.clone()),
1055 Recipient::PhantomNode => Err(())
1057 if let Some(tweak) = tweak {
1058 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1060 Ok(SharedSecret::new(other_key, &node_secret))
1063 fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
1067 fn sign_bolt12_invoice_request(
1068 &self, _invoice_request: &UnsignedInvoiceRequest
1069 ) -> Result<schnorr::Signature, ()> {
1073 fn sign_bolt12_invoice(
1074 &self, _invoice: &UnsignedBolt12Invoice,
1075 ) -> Result<schnorr::Signature, ()> {
1079 fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1084 pub struct TestKeysInterface {
1085 pub backing: sign::PhantomKeysManager,
1086 pub override_random_bytes: Mutex<Option<[u8; 32]>>,
1087 pub disable_revocation_policy_check: bool,
1088 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
1089 expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
1092 impl EntropySource for TestKeysInterface {
1093 fn get_secure_random_bytes(&self) -> [u8; 32] {
1094 let override_random_bytes = self.override_random_bytes.lock().unwrap();
1095 if let Some(bytes) = &*override_random_bytes {
1098 self.backing.get_secure_random_bytes()
1102 impl NodeSigner for TestKeysInterface {
1103 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1104 self.backing.get_node_id(recipient)
1107 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1108 self.backing.ecdh(recipient, other_key, tweak)
1111 fn get_inbound_payment_key_material(&self) -> sign::KeyMaterial {
1112 self.backing.get_inbound_payment_key_material()
1115 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1116 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
1119 fn sign_bolt12_invoice_request(
1120 &self, invoice_request: &UnsignedInvoiceRequest
1121 ) -> Result<schnorr::Signature, ()> {
1122 self.backing.sign_bolt12_invoice_request(invoice_request)
1125 fn sign_bolt12_invoice(
1126 &self, invoice: &UnsignedBolt12Invoice,
1127 ) -> Result<schnorr::Signature, ()> {
1128 self.backing.sign_bolt12_invoice(invoice)
1131 fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1132 self.backing.sign_gossip_message(msg)
1136 impl SignerProvider for TestKeysInterface {
1137 type EcdsaSigner = TestChannelSigner;
1139 type TaprootSigner = TestChannelSigner;
1141 fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1142 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1145 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> TestChannelSigner {
1146 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_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 read_chan_signer(&self, buffer: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
1152 let mut reader = io::Cursor::new(buffer);
1154 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
1155 let state = self.make_enforcement_state_cell(inner.commitment_seed);
1157 Ok(TestChannelSigner::new_with_revoked(
1160 self.disable_revocation_policy_check
1164 fn get_destination_script(&self, channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { self.backing.get_destination_script(channel_keys_id) }
1166 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1167 match &mut *self.expectations.lock().unwrap() {
1168 None => self.backing.get_shutdown_scriptpubkey(),
1169 Some(expectations) => match expectations.pop_front() {
1170 None => panic!("Unexpected get_shutdown_scriptpubkey"),
1171 Some(expectation) => Ok(expectation.returns),
1177 impl TestKeysInterface {
1178 pub fn new(seed: &[u8; 32], network: Network) -> Self {
1179 let now = Duration::from_secs(genesis_block(network).header.time as u64);
1181 backing: sign::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
1182 override_random_bytes: Mutex::new(None),
1183 disable_revocation_policy_check: false,
1184 enforcement_states: Mutex::new(HashMap::new()),
1185 expectations: Mutex::new(None),
1189 /// Sets an expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] is
1191 pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
1192 self.expectations.lock().unwrap()
1193 .get_or_insert_with(|| VecDeque::new())
1194 .push_back(expectation);
1198 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> TestChannelSigner {
1199 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
1200 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1201 TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
1204 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
1205 let mut states = self.enforcement_states.lock().unwrap();
1206 if !states.contains_key(&commitment_seed) {
1207 let state = EnforcementState::new();
1208 states.insert(commitment_seed, Arc::new(Mutex::new(state)));
1210 let cell = states.get(&commitment_seed).unwrap();
1215 pub(crate) fn panicking() -> bool {
1216 #[cfg(feature = "std")]
1217 let panicking = ::std::thread::panicking();
1218 #[cfg(not(feature = "std"))]
1219 let panicking = false;
1223 impl Drop for TestKeysInterface {
1224 fn drop(&mut self) {
1229 if let Some(expectations) = &*self.expectations.lock().unwrap() {
1230 if !expectations.is_empty() {
1231 panic!("Unsatisfied expectations: {:?}", expectations);
1237 /// An expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] was called and
1238 /// returns a [`ShutdownScript`].
1239 pub struct OnGetShutdownScriptpubkey {
1240 /// A shutdown script used to close a channel.
1241 pub returns: ShutdownScript,
1244 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
1245 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
1246 f.debug_struct("OnGetShutdownScriptpubkey").finish()
1250 pub struct TestChainSource {
1251 pub chain_hash: ChainHash,
1252 pub utxo_ret: Mutex<UtxoResult>,
1253 pub get_utxo_call_count: AtomicUsize,
1254 pub watched_txn: Mutex<HashSet<(Txid, ScriptBuf)>>,
1255 pub watched_outputs: Mutex<HashSet<(OutPoint, ScriptBuf)>>,
1258 impl TestChainSource {
1259 pub fn new(network: Network) -> Self {
1260 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1262 chain_hash: ChainHash::using_genesis_block(network),
1263 utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
1264 get_utxo_call_count: AtomicUsize::new(0),
1265 watched_txn: Mutex::new(HashSet::new()),
1266 watched_outputs: Mutex::new(HashSet::new()),
1271 impl UtxoLookup for TestChainSource {
1272 fn get_utxo(&self, chain_hash: &ChainHash, _short_channel_id: u64) -> UtxoResult {
1273 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
1274 if self.chain_hash != *chain_hash {
1275 return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
1278 self.utxo_ret.lock().unwrap().clone()
1282 impl chain::Filter for TestChainSource {
1283 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
1284 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.into()));
1287 fn register_output(&self, output: WatchedOutput) {
1288 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
1292 impl Drop for TestChainSource {
1293 fn drop(&mut self) {
1300 pub struct TestScorer {
1301 /// Stores a tuple of (scid, ChannelUsage)
1302 scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
1306 pub fn new() -> Self {
1308 scorer_expectations: RefCell::new(None),
1312 pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
1313 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
1318 impl crate::util::ser::Writeable for TestScorer {
1319 fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
1322 impl ScoreLookUp for TestScorer {
1323 type ScoreParams = ();
1324 fn channel_penalty_msat(
1325 &self, candidate: &CandidateRouteHop, usage: ChannelUsage, _score_params: &Self::ScoreParams
1327 let short_channel_id = match candidate.short_channel_id() {
1331 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
1332 match scorer_expectations.pop_front() {
1333 Some((scid, expectation)) => {
1334 assert_eq!(expectation, usage);
1335 assert_eq!(scid, short_channel_id);
1344 impl ScoreUpdate for TestScorer {
1345 fn payment_path_failed(&mut self, _actual_path: &Path, _actual_short_channel_id: u64) {}
1347 fn payment_path_successful(&mut self, _actual_path: &Path) {}
1349 fn probe_failed(&mut self, _actual_path: &Path, _: u64) {}
1351 fn probe_successful(&mut self, _actual_path: &Path) {}
1354 impl Drop for TestScorer {
1355 fn drop(&mut self) {
1356 #[cfg(feature = "std")] {
1357 if std::thread::panicking() {
1362 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
1363 if !scorer_expectations.is_empty() {
1364 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
1370 pub struct TestWalletSource {
1371 secret_key: SecretKey,
1372 utxos: RefCell<Vec<Utxo>>,
1373 secp: Secp256k1<bitcoin::secp256k1::All>,
1376 impl TestWalletSource {
1377 pub fn new(secret_key: SecretKey) -> Self {
1380 utxos: RefCell::new(Vec::new()),
1381 secp: Secp256k1::new(),
1385 pub fn add_utxo(&self, outpoint: bitcoin::OutPoint, value: u64) -> TxOut {
1386 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1387 let utxo = Utxo::new_p2pkh(outpoint, value, &public_key.pubkey_hash());
1388 self.utxos.borrow_mut().push(utxo.clone());
1392 pub fn add_custom_utxo(&self, utxo: Utxo) -> TxOut {
1393 let output = utxo.output.clone();
1394 self.utxos.borrow_mut().push(utxo);
1398 pub fn remove_utxo(&self, outpoint: bitcoin::OutPoint) {
1399 self.utxos.borrow_mut().retain(|utxo| utxo.outpoint != outpoint);
1403 impl WalletSource for TestWalletSource {
1404 fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()> {
1405 Ok(self.utxos.borrow().clone())
1408 fn get_change_script(&self) -> Result<ScriptBuf, ()> {
1409 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1410 Ok(ScriptBuf::new_p2pkh(&public_key.pubkey_hash()))
1413 fn sign_tx(&self, mut tx: Transaction) -> Result<Transaction, ()> {
1414 let utxos = self.utxos.borrow();
1415 for i in 0..tx.input.len() {
1416 if let Some(utxo) = utxos.iter().find(|utxo| utxo.outpoint == tx.input[i].previous_output) {
1417 let sighash = SighashCache::new(&tx)
1418 .legacy_signature_hash(i, &utxo.output.script_pubkey, EcdsaSighashType::All as u32)
1420 let sig = self.secp.sign_ecdsa(&(*sighash.as_raw_hash()).into(), &self.secret_key);
1421 let bitcoin_sig = bitcoin::ecdsa::Signature { sig, hash_ty: EcdsaSighashType::All };
1422 tx.input[i].script_sig = Builder::new()
1423 .push_slice(&bitcoin_sig.serialize())
1424 .push_slice(&self.secret_key.public_key(&self.secp).serialize())