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
10 use crate::blinded_path::BlindedPath;
11 use crate::blinded_path::payment::ReceiveTlvs;
13 use crate::chain::WatchedOutput;
14 use crate::chain::chaininterface;
15 use crate::chain::chaininterface::ConfirmationTarget;
16 use crate::chain::chaininterface::FEERATE_FLOOR_SATS_PER_KW;
17 use crate::chain::chainmonitor;
18 use crate::chain::chainmonitor::{MonitorUpdateId, UpdateOrigin};
19 use crate::chain::channelmonitor;
20 use crate::chain::channelmonitor::MonitorEvent;
21 use crate::chain::transaction::OutPoint;
22 use crate::routing::router::{CandidateRouteHop, FirstHopCandidate, PublicHopCandidate, PrivateHopCandidate};
25 use crate::events::bump_transaction::{WalletSource, Utxo};
26 use crate::ln::ChannelId;
27 use crate::ln::channelmanager::{ChannelDetails, self};
28 use crate::ln::chan_utils::CommitmentTransaction;
29 use crate::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
30 use crate::ln::{msgs, wire};
31 use crate::ln::msgs::LightningError;
32 use crate::ln::script::ShutdownScript;
33 use crate::offers::invoice::{BlindedPayInfo, UnsignedBolt12Invoice};
34 use crate::offers::invoice_request::UnsignedInvoiceRequest;
35 use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageRouter, OnionMessagePath};
36 use crate::routing::gossip::{EffectiveCapacity, NetworkGraph, NodeId, RoutingFees};
37 use crate::routing::utxo::{UtxoLookup, UtxoLookupError, UtxoResult};
38 use crate::routing::router::{DefaultRouter, InFlightHtlcs, Path, Route, RouteParameters, RouteHintHop, Router, ScorerAccountingForInFlightHtlcs};
39 use crate::routing::scoring::{ChannelUsage, ScoreUpdate, ScoreLookUp};
40 use crate::sync::RwLock;
41 use crate::util::config::UserConfig;
42 use crate::util::test_channel_signer::{TestChannelSigner, EnforcementState};
43 use crate::util::logger::{Logger, Level, Record};
44 use crate::util::ser::{Readable, ReadableArgs, Writer, Writeable};
45 use crate::util::persist::KVStore;
47 use bitcoin::blockdata::constants::ChainHash;
48 use bitcoin::blockdata::constants::genesis_block;
49 use bitcoin::blockdata::transaction::{Transaction, TxOut};
50 use bitcoin::blockdata::script::{Builder, Script, ScriptBuf};
51 use bitcoin::blockdata::opcodes;
52 use bitcoin::blockdata::block::Block;
53 use bitcoin::network::constants::Network;
54 use bitcoin::hash_types::{BlockHash, Txid};
55 use bitcoin::sighash::{SighashCache, EcdsaSighashType};
57 use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, self};
58 use bitcoin::secp256k1::ecdh::SharedSecret;
59 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
60 use bitcoin::secp256k1::schnorr;
62 #[cfg(any(test, feature = "_test_utils"))]
66 use crate::prelude::*;
67 use core::cell::RefCell;
68 use core::time::Duration;
69 use crate::sync::{Mutex, Arc};
70 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
72 use bitcoin::bech32::u5;
73 use crate::sign::{InMemorySigner, RandomBytes, Recipient, EntropySource, NodeSigner, SignerProvider};
75 #[cfg(feature = "std")]
76 use std::time::{SystemTime, UNIX_EPOCH};
77 use bitcoin::psbt::PartiallySignedTransaction;
78 use bitcoin::Sequence;
80 pub fn pubkey(byte: u8) -> PublicKey {
81 let secp_ctx = Secp256k1::new();
82 PublicKey::from_secret_key(&secp_ctx, &privkey(byte))
85 pub fn privkey(byte: u8) -> SecretKey {
86 SecretKey::from_slice(&[byte; 32]).unwrap()
89 pub struct TestVecWriter(pub Vec<u8>);
90 impl Writer for TestVecWriter {
91 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
92 self.0.extend_from_slice(buf);
97 pub struct TestFeeEstimator {
98 pub sat_per_kw: Mutex<u32>,
100 impl chaininterface::FeeEstimator for TestFeeEstimator {
101 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
102 *self.sat_per_kw.lock().unwrap()
106 pub struct TestRouter<'a> {
107 pub router: DefaultRouter<
108 Arc<NetworkGraph<&'a TestLogger>>,
111 &'a RwLock<TestScorer>,
115 //pub entropy_source: &'a RandomBytes,
116 pub network_graph: Arc<NetworkGraph<&'a TestLogger>>,
117 pub next_routes: Mutex<VecDeque<(RouteParameters, Result<Route, LightningError>)>>,
118 pub scorer: &'a RwLock<TestScorer>,
121 impl<'a> TestRouter<'a> {
123 network_graph: Arc<NetworkGraph<&'a TestLogger>>, logger: &'a TestLogger,
124 scorer: &'a RwLock<TestScorer>,
126 let entropy_source = Arc::new(RandomBytes::new([42; 32]));
128 router: DefaultRouter::new(network_graph.clone(), logger, entropy_source, scorer, ()),
130 next_routes: Mutex::new(VecDeque::new()),
135 pub fn expect_find_route(&self, query: RouteParameters, result: Result<Route, LightningError>) {
136 let mut expected_routes = self.next_routes.lock().unwrap();
137 expected_routes.push_back((query, result));
141 impl<'a> Router for TestRouter<'a> {
143 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
144 inflight_htlcs: InFlightHtlcs
145 ) -> Result<Route, msgs::LightningError> {
147 let next_route_opt = self.next_routes.lock().unwrap().pop_front();
148 if let Some((find_route_query, find_route_res)) = next_route_opt {
149 assert_eq!(find_route_query, *params);
150 if let Ok(ref route) = find_route_res {
151 assert_eq!(route.route_params, Some(find_route_query));
152 let scorer = self.scorer.read().unwrap();
153 let scorer = ScorerAccountingForInFlightHtlcs::new(scorer, &inflight_htlcs);
154 for path in &route.paths {
155 let mut aggregate_msat = 0u64;
156 let mut prev_hop_node = payer;
157 for (idx, hop) in path.hops.iter().rev().enumerate() {
158 aggregate_msat += hop.fee_msat;
159 let usage = ChannelUsage {
160 amount_msat: aggregate_msat,
161 inflight_htlc_msat: 0,
162 effective_capacity: EffectiveCapacity::Unknown,
165 if idx == path.hops.len() - 1 {
166 if let Some(first_hops) = first_hops {
167 if let Some(idx) = first_hops.iter().position(|h| h.get_outbound_payment_scid() == Some(hop.short_channel_id)) {
168 let node_id = NodeId::from_pubkey(payer);
169 let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
170 details: first_hops[idx],
171 payer_node_id: &node_id,
173 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
178 let network_graph = self.network_graph.read_only();
179 if let Some(channel) = network_graph.channel(hop.short_channel_id) {
180 let (directed, _) = channel.as_directed_to(&NodeId::from_pubkey(&hop.pubkey)).unwrap();
181 let candidate = CandidateRouteHop::PublicHop(PublicHopCandidate {
183 short_channel_id: hop.short_channel_id,
185 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
187 let target_node_id = NodeId::from_pubkey(&hop.pubkey);
188 let route_hint = RouteHintHop {
189 src_node_id: *prev_hop_node,
190 short_channel_id: hop.short_channel_id,
191 fees: RoutingFees { base_msat: 0, proportional_millionths: 0 },
192 cltv_expiry_delta: 0,
193 htlc_minimum_msat: None,
194 htlc_maximum_msat: None,
196 let candidate = CandidateRouteHop::PrivateHop(PrivateHopCandidate {
198 target_node_id: &target_node_id,
200 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
202 prev_hop_node = &hop.pubkey;
206 route_res = find_route_res;
208 route_res = self.router.find_route(payer, params, first_hops, inflight_htlcs);
211 if let Ok(route) = &route_res {
212 // Previously, `Route`s failed to round-trip through serialization due to a write/read
213 // mismatch. Thus, here we test all test-generated routes round-trip:
214 let ser = route.encode();
215 assert_eq!(Route::read(&mut &ser[..]).unwrap(), *route);
220 fn create_blinded_payment_paths<
221 T: secp256k1::Signing + secp256k1::Verification
223 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
224 amount_msats: u64, secp_ctx: &Secp256k1<T>,
225 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
226 self.router.create_blinded_payment_paths(
227 recipient, first_hops, tlvs, amount_msats, secp_ctx
232 impl<'a> MessageRouter for TestRouter<'a> {
234 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
235 ) -> Result<OnionMessagePath, ()> {
236 self.router.find_path(sender, peers, destination)
239 fn create_blinded_paths<
240 T: secp256k1::Signing + secp256k1::Verification
242 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
243 ) -> Result<Vec<BlindedPath>, ()> {
244 self.router.create_blinded_paths(recipient, peers, secp_ctx)
248 impl<'a> Drop for TestRouter<'a> {
250 #[cfg(feature = "std")] {
251 if std::thread::panicking() {
255 assert!(self.next_routes.lock().unwrap().is_empty());
259 pub struct TestMessageRouter<'a> {
260 inner: DefaultMessageRouter<Arc<NetworkGraph<&'a TestLogger>>, &'a TestLogger, &'a TestKeysInterface>,
263 impl<'a> TestMessageRouter<'a> {
264 pub fn new(network_graph: Arc<NetworkGraph<&'a TestLogger>>, entropy_source: &'a TestKeysInterface) -> Self {
265 Self { inner: DefaultMessageRouter::new(network_graph, entropy_source) }
269 impl<'a> MessageRouter for TestMessageRouter<'a> {
271 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
272 ) -> Result<OnionMessagePath, ()> {
273 self.inner.find_path(sender, peers, destination)
276 fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
277 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
278 ) -> Result<Vec<BlindedPath>, ()> {
279 self.inner.create_blinded_paths(recipient, peers, secp_ctx)
283 pub struct OnlyReadsKeysInterface {}
285 impl EntropySource for OnlyReadsKeysInterface {
286 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
288 impl SignerProvider for OnlyReadsKeysInterface {
289 type EcdsaSigner = TestChannelSigner;
291 type TaprootSigner = TestChannelSigner;
293 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
295 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner { unreachable!(); }
297 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
298 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
299 let state = Arc::new(Mutex::new(EnforcementState::new()));
301 Ok(TestChannelSigner::new_with_revoked(
308 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { Err(()) }
309 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { Err(()) }
312 pub struct TestChainMonitor<'a> {
313 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<TestChannelSigner>)>>,
314 pub monitor_updates: Mutex<HashMap<ChannelId, Vec<channelmonitor::ChannelMonitorUpdate>>>,
315 pub latest_monitor_update_id: Mutex<HashMap<ChannelId, (OutPoint, u64, MonitorUpdateId)>>,
316 pub chain_monitor: chainmonitor::ChainMonitor<TestChannelSigner, &'a TestChainSource, &'a dyn chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a dyn chainmonitor::Persist<TestChannelSigner>>,
317 pub keys_manager: &'a TestKeysInterface,
318 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
319 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
321 pub expect_channel_force_closed: Mutex<Option<(ChannelId, bool)>>,
322 /// If this is set to Some(), the next round trip serialization check will not hold after an
323 /// update_channel call (not watch_channel) for the given channel_id.
324 pub expect_monitor_round_trip_fail: Mutex<Option<ChannelId>>,
326 impl<'a> TestChainMonitor<'a> {
327 pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a dyn chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a dyn chainmonitor::Persist<TestChannelSigner>, keys_manager: &'a TestKeysInterface) -> Self {
329 added_monitors: Mutex::new(Vec::new()),
330 monitor_updates: Mutex::new(new_hash_map()),
331 latest_monitor_update_id: Mutex::new(new_hash_map()),
332 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
334 expect_channel_force_closed: Mutex::new(None),
335 expect_monitor_round_trip_fail: Mutex::new(None),
339 pub fn complete_sole_pending_chan_update(&self, channel_id: &ChannelId) {
340 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
341 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
344 impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {
345 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
346 // At every point where we get a monitor update, we should be able to send a useful monitor
347 // to a watchtower and disk...
348 let mut w = TestVecWriter(Vec::new());
349 monitor.write(&mut w).unwrap();
350 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
351 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
352 assert!(new_monitor == monitor);
353 self.latest_monitor_update_id.lock().unwrap().insert(monitor.channel_id(),
354 (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
355 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
356 self.chain_monitor.watch_channel(funding_txo, new_monitor)
359 fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
360 // Every monitor update should survive roundtrip
361 let mut w = TestVecWriter(Vec::new());
362 update.write(&mut w).unwrap();
363 assert!(channelmonitor::ChannelMonitorUpdate::read(
364 &mut io::Cursor::new(&w.0)).unwrap() == *update);
365 let channel_id = update.channel_id.unwrap_or(ChannelId::v1_from_funding_outpoint(funding_txo));
367 self.monitor_updates.lock().unwrap().entry(channel_id).or_insert(Vec::new()).push(update.clone());
369 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
370 assert_eq!(channel_id, exp.0);
371 assert_eq!(update.updates.len(), 1);
372 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
373 assert_eq!(should_broadcast, exp.1);
377 self.latest_monitor_update_id.lock().unwrap().insert(channel_id,
378 (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(update)));
379 let update_res = self.chain_monitor.update_channel(funding_txo, update);
380 // At every point where we get a monitor update, we should be able to send a useful monitor
381 // to a watchtower and disk...
382 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
384 monitor.write(&mut w).unwrap();
385 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
386 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
387 if let Some(chan_id) = self.expect_monitor_round_trip_fail.lock().unwrap().take() {
388 assert_eq!(chan_id, channel_id);
389 assert!(new_monitor != *monitor);
391 assert!(new_monitor == *monitor);
393 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
397 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, Option<PublicKey>)> {
398 return self.chain_monitor.release_pending_monitor_events();
402 struct JusticeTxData {
403 justice_tx: Transaction,
405 commitment_number: u64,
408 pub(crate) struct WatchtowerPersister {
409 persister: TestPersister,
410 /// Upon a new commitment_signed, we'll get a
411 /// ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTxInfo. We'll store the justice tx
412 /// amount, and commitment number so we can build the justice tx after our counterparty
414 unsigned_justice_tx_data: Mutex<HashMap<OutPoint, VecDeque<JusticeTxData>>>,
415 /// After receiving a revoke_and_ack for a commitment number, we'll form and store the justice
416 /// tx which would be used to provide a watchtower with the data it needs.
417 watchtower_state: Mutex<HashMap<OutPoint, HashMap<Txid, Transaction>>>,
418 destination_script: ScriptBuf,
421 impl WatchtowerPersister {
423 pub(crate) fn new(destination_script: ScriptBuf) -> Self {
424 WatchtowerPersister {
425 persister: TestPersister::new(),
426 unsigned_justice_tx_data: Mutex::new(new_hash_map()),
427 watchtower_state: Mutex::new(new_hash_map()),
433 pub(crate) fn justice_tx(&self, funding_txo: OutPoint, commitment_txid: &Txid)
434 -> Option<Transaction> {
435 self.watchtower_state.lock().unwrap().get(&funding_txo).unwrap().get(commitment_txid).cloned()
438 fn form_justice_data_from_commitment(&self, counterparty_commitment_tx: &CommitmentTransaction)
439 -> Option<JusticeTxData> {
440 let trusted_tx = counterparty_commitment_tx.trust();
441 let output_idx = trusted_tx.revokeable_output_index()?;
442 let built_tx = trusted_tx.built_transaction();
443 let value = built_tx.transaction.output[output_idx as usize].value;
444 let justice_tx = trusted_tx.build_to_local_justice_tx(
445 FEERATE_FLOOR_SATS_PER_KW as u64, self.destination_script.clone()).ok()?;
446 let commitment_number = counterparty_commitment_tx.commitment_number();
447 Some(JusticeTxData { justice_tx, value, commitment_number })
451 impl<Signer: sign::ecdsa::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for WatchtowerPersister {
452 fn persist_new_channel(&self, funding_txo: OutPoint,
453 data: &channelmonitor::ChannelMonitor<Signer>, id: MonitorUpdateId
454 ) -> chain::ChannelMonitorUpdateStatus {
455 let res = self.persister.persist_new_channel(funding_txo, data, id);
457 assert!(self.unsigned_justice_tx_data.lock().unwrap()
458 .insert(funding_txo, VecDeque::new()).is_none());
459 assert!(self.watchtower_state.lock().unwrap()
460 .insert(funding_txo, new_hash_map()).is_none());
462 let initial_counterparty_commitment_tx = data.initial_counterparty_commitment_tx()
463 .expect("First and only call expects Some");
464 if let Some(justice_data)
465 = self.form_justice_data_from_commitment(&initial_counterparty_commitment_tx) {
466 self.unsigned_justice_tx_data.lock().unwrap()
467 .get_mut(&funding_txo).unwrap()
468 .push_back(justice_data);
473 fn update_persisted_channel(
474 &self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>,
475 data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId
476 ) -> chain::ChannelMonitorUpdateStatus {
477 let res = self.persister.update_persisted_channel(funding_txo, update, data, update_id);
479 if let Some(update) = update {
480 let commitment_txs = data.counterparty_commitment_txs_from_update(update);
481 let justice_datas = commitment_txs.into_iter()
482 .filter_map(|commitment_tx| self.form_justice_data_from_commitment(&commitment_tx));
483 let mut channels_justice_txs = self.unsigned_justice_tx_data.lock().unwrap();
484 let channel_state = channels_justice_txs.get_mut(&funding_txo).unwrap();
485 channel_state.extend(justice_datas);
487 while let Some(JusticeTxData { justice_tx, value, commitment_number }) = channel_state.front() {
489 let commitment_txid = justice_tx.input[input_idx].previous_output.txid;
490 match data.sign_to_local_justice_tx(justice_tx.clone(), input_idx, *value, *commitment_number) {
491 Ok(signed_justice_tx) => {
492 let dup = self.watchtower_state.lock().unwrap()
493 .get_mut(&funding_txo).unwrap()
494 .insert(commitment_txid, signed_justice_tx);
495 assert!(dup.is_none());
496 channel_state.pop_front();
506 pub struct TestPersister {
507 /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
509 pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
510 /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
511 /// MonitorUpdateId here.
512 pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
513 /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
514 /// MonitorUpdateId here.
515 pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
518 pub fn new() -> Self {
520 update_rets: Mutex::new(VecDeque::new()),
521 chain_sync_monitor_persistences: Mutex::new(new_hash_map()),
522 offchain_monitor_updates: Mutex::new(new_hash_map()),
526 /// Queue an update status to return.
527 pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
528 self.update_rets.lock().unwrap().push_back(next_ret);
531 impl<Signer: sign::ecdsa::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
532 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
533 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
536 chain::ChannelMonitorUpdateStatus::Completed
539 fn update_persisted_channel(&self, funding_txo: OutPoint, _update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
540 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
541 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
544 let is_chain_sync = if let UpdateOrigin::ChainSync(_) = update_id.contents { true } else { false };
546 self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(new_hash_set()).insert(update_id);
548 self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(new_hash_set()).insert(update_id);
554 pub struct TestStore {
555 persisted_bytes: Mutex<HashMap<String, HashMap<String, Vec<u8>>>>,
560 pub fn new(read_only: bool) -> Self {
561 let persisted_bytes = Mutex::new(new_hash_map());
562 Self { persisted_bytes, read_only }
566 impl KVStore for TestStore {
567 fn read(&self, primary_namespace: &str, secondary_namespace: &str, key: &str) -> io::Result<Vec<u8>> {
568 let persisted_lock = self.persisted_bytes.lock().unwrap();
569 let prefixed = if secondary_namespace.is_empty() {
570 primary_namespace.to_string()
572 format!("{}/{}", primary_namespace, secondary_namespace)
575 if let Some(outer_ref) = persisted_lock.get(&prefixed) {
576 if let Some(inner_ref) = outer_ref.get(key) {
577 let bytes = inner_ref.clone();
580 Err(io::Error::new(io::ErrorKind::NotFound, "Key not found"))
583 Err(io::Error::new(io::ErrorKind::NotFound, "Namespace not found"))
587 fn write(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: &[u8]) -> io::Result<()> {
589 return Err(io::Error::new(
590 io::ErrorKind::PermissionDenied,
591 "Cannot modify read-only store",
594 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
596 let prefixed = if secondary_namespace.is_empty() {
597 primary_namespace.to_string()
599 format!("{}/{}", primary_namespace, secondary_namespace)
601 let outer_e = persisted_lock.entry(prefixed).or_insert(new_hash_map());
602 let mut bytes = Vec::new();
603 bytes.write_all(buf)?;
604 outer_e.insert(key.to_string(), bytes);
608 fn remove(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, _lazy: bool) -> io::Result<()> {
610 return Err(io::Error::new(
611 io::ErrorKind::PermissionDenied,
612 "Cannot modify read-only store",
616 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
618 let prefixed = if secondary_namespace.is_empty() {
619 primary_namespace.to_string()
621 format!("{}/{}", primary_namespace, secondary_namespace)
623 if let Some(outer_ref) = persisted_lock.get_mut(&prefixed) {
624 outer_ref.remove(&key.to_string());
630 fn list(&self, primary_namespace: &str, secondary_namespace: &str) -> io::Result<Vec<String>> {
631 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
633 let prefixed = if secondary_namespace.is_empty() {
634 primary_namespace.to_string()
636 format!("{}/{}", primary_namespace, secondary_namespace)
638 match persisted_lock.entry(prefixed) {
639 hash_map::Entry::Occupied(e) => Ok(e.get().keys().cloned().collect()),
640 hash_map::Entry::Vacant(_) => Ok(Vec::new()),
645 unsafe impl Sync for TestStore {}
646 unsafe impl Send for TestStore {}
648 pub struct TestBroadcaster {
649 pub txn_broadcasted: Mutex<Vec<Transaction>>,
650 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
653 impl TestBroadcaster {
654 pub fn new(network: Network) -> Self {
656 txn_broadcasted: Mutex::new(Vec::new()),
657 blocks: Arc::new(Mutex::new(vec![(genesis_block(network), 0)])),
661 pub fn with_blocks(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> Self {
662 Self { txn_broadcasted: Mutex::new(Vec::new()), blocks }
665 pub fn txn_broadcast(&self) -> Vec<Transaction> {
666 self.txn_broadcasted.lock().unwrap().split_off(0)
669 pub fn unique_txn_broadcast(&self) -> Vec<Transaction> {
670 let mut txn = self.txn_broadcasted.lock().unwrap().split_off(0);
671 let mut seen = new_hash_set();
672 txn.retain(|tx| seen.insert(tx.txid()));
677 impl chaininterface::BroadcasterInterface for TestBroadcaster {
678 fn broadcast_transactions(&self, txs: &[&Transaction]) {
680 let lock_time = tx.lock_time.to_consensus_u32();
681 assert!(lock_time < 1_500_000_000);
682 if tx.lock_time.is_block_height() && lock_time > self.blocks.lock().unwrap().last().unwrap().1 {
683 for inp in tx.input.iter() {
684 if inp.sequence != Sequence::MAX {
685 panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
690 let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
691 self.txn_broadcasted.lock().unwrap().extend(owned_txs);
695 pub struct TestChannelMessageHandler {
696 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
697 expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
698 connected_peers: Mutex<HashSet<PublicKey>>,
699 pub message_fetch_counter: AtomicUsize,
700 chain_hash: ChainHash,
703 impl TestChannelMessageHandler {
704 pub fn new(chain_hash: ChainHash) -> Self {
705 TestChannelMessageHandler {
706 pending_events: Mutex::new(Vec::new()),
707 expected_recv_msgs: Mutex::new(None),
708 connected_peers: Mutex::new(new_hash_set()),
709 message_fetch_counter: AtomicUsize::new(0),
715 pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
716 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
717 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
718 expected_msgs.as_mut().unwrap().push(ev);
721 fn received_msg(&self, _ev: wire::Message<()>) {
722 let mut msgs = self.expected_recv_msgs.lock().unwrap();
723 if msgs.is_none() { return; }
724 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
726 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
727 msgs.as_mut().unwrap().remove(0);
731 impl Drop for TestChannelMessageHandler {
733 #[cfg(feature = "std")]
735 let l = self.expected_recv_msgs.lock().unwrap();
736 if !std::thread::panicking() {
737 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
743 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
744 fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
745 self.received_msg(wire::Message::OpenChannel(msg.clone()));
747 fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
748 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
750 fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
751 self.received_msg(wire::Message::FundingCreated(msg.clone()));
753 fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
754 self.received_msg(wire::Message::FundingSigned(msg.clone()));
756 fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
757 self.received_msg(wire::Message::ChannelReady(msg.clone()));
759 fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
760 self.received_msg(wire::Message::Shutdown(msg.clone()));
762 fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
763 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
765 fn handle_stfu(&self, _their_node_id: &PublicKey, msg: &msgs::Stfu) {
766 self.received_msg(wire::Message::Stfu(msg.clone()));
768 fn handle_splice(&self, _their_node_id: &PublicKey, msg: &msgs::Splice) {
769 self.received_msg(wire::Message::Splice(msg.clone()));
771 fn handle_splice_ack(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
772 self.received_msg(wire::Message::SpliceAck(msg.clone()));
774 fn handle_splice_locked(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
775 self.received_msg(wire::Message::SpliceLocked(msg.clone()));
777 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
778 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
780 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
781 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
783 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
784 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
786 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
787 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
789 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
790 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
792 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
793 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
795 fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
796 self.received_msg(wire::Message::UpdateFee(msg.clone()));
798 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
799 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
801 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
802 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
804 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
805 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
807 fn peer_disconnected(&self, their_node_id: &PublicKey) {
808 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
810 fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
811 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
812 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
813 // bother re-generating the expected Init message in all tests.
816 fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
817 self.received_msg(wire::Message::Error(msg.clone()));
819 fn provided_node_features(&self) -> NodeFeatures {
820 channelmanager::provided_node_features(&UserConfig::default())
822 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
823 channelmanager::provided_init_features(&UserConfig::default())
826 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
827 Some(vec![self.chain_hash])
830 fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
831 self.received_msg(wire::Message::OpenChannelV2(msg.clone()));
834 fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
835 self.received_msg(wire::Message::AcceptChannelV2(msg.clone()));
838 fn handle_tx_add_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
839 self.received_msg(wire::Message::TxAddInput(msg.clone()));
842 fn handle_tx_add_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
843 self.received_msg(wire::Message::TxAddOutput(msg.clone()));
846 fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
847 self.received_msg(wire::Message::TxRemoveInput(msg.clone()));
850 fn handle_tx_remove_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
851 self.received_msg(wire::Message::TxRemoveOutput(msg.clone()));
854 fn handle_tx_complete(&self, _their_node_id: &PublicKey, msg: &msgs::TxComplete) {
855 self.received_msg(wire::Message::TxComplete(msg.clone()));
858 fn handle_tx_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
859 self.received_msg(wire::Message::TxSignatures(msg.clone()));
862 fn handle_tx_init_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
863 self.received_msg(wire::Message::TxInitRbf(msg.clone()));
866 fn handle_tx_ack_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
867 self.received_msg(wire::Message::TxAckRbf(msg.clone()));
870 fn handle_tx_abort(&self, _their_node_id: &PublicKey, msg: &msgs::TxAbort) {
871 self.received_msg(wire::Message::TxAbort(msg.clone()));
875 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
876 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
877 self.message_fetch_counter.fetch_add(1, Ordering::AcqRel);
878 let mut pending_events = self.pending_events.lock().unwrap();
879 let mut ret = Vec::new();
880 mem::swap(&mut ret, &mut *pending_events);
885 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
886 use bitcoin::secp256k1::ffi::Signature as FFISignature;
887 let secp_ctx = Secp256k1::new();
888 let network = Network::Testnet;
889 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
890 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
891 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
892 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
893 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
894 features: ChannelFeatures::empty(),
895 chain_hash: ChainHash::using_genesis_block(network),
896 short_channel_id: short_chan_id,
897 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
898 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
899 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
900 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
901 excess_data: Vec::new(),
905 msgs::ChannelAnnouncement {
906 node_signature_1: Signature::from(FFISignature::new()),
907 node_signature_2: Signature::from(FFISignature::new()),
908 bitcoin_signature_1: Signature::from(FFISignature::new()),
909 bitcoin_signature_2: Signature::from(FFISignature::new()),
910 contents: unsigned_ann,
915 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
916 use bitcoin::secp256k1::ffi::Signature as FFISignature;
917 let network = Network::Testnet;
918 msgs::ChannelUpdate {
919 signature: Signature::from(unsafe { FFISignature::new() }),
920 contents: msgs::UnsignedChannelUpdate {
921 chain_hash: ChainHash::using_genesis_block(network),
922 short_channel_id: short_chan_id,
925 cltv_expiry_delta: 0,
926 htlc_minimum_msat: 0,
927 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
929 fee_proportional_millionths: 0,
935 pub struct TestRoutingMessageHandler {
936 pub chan_upds_recvd: AtomicUsize,
937 pub chan_anns_recvd: AtomicUsize,
938 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
939 pub request_full_sync: AtomicBool,
942 impl TestRoutingMessageHandler {
943 pub fn new() -> Self {
944 TestRoutingMessageHandler {
945 chan_upds_recvd: AtomicUsize::new(0),
946 chan_anns_recvd: AtomicUsize::new(0),
947 pending_events: Mutex::new(vec![]),
948 request_full_sync: AtomicBool::new(false),
952 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
953 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
954 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
956 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
957 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
958 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
960 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
961 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
962 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
964 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
965 let chan_upd_1 = get_dummy_channel_update(starting_point);
966 let chan_upd_2 = get_dummy_channel_update(starting_point);
967 let chan_ann = get_dummy_channel_announcement(starting_point);
969 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
972 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
976 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
977 if !init_msg.features.supports_gossip_queries() {
981 #[allow(unused_mut, unused_assignments)]
982 let mut gossip_start_time = 0;
983 #[cfg(feature = "std")]
985 gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
986 if self.request_full_sync.load(Ordering::Acquire) {
987 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
989 gossip_start_time -= 60 * 60; // an hour ago
993 let mut pending_events = self.pending_events.lock().unwrap();
994 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
995 node_id: their_node_id.clone(),
996 msg: msgs::GossipTimestampFilter {
997 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
998 first_timestamp: gossip_start_time as u32,
999 timestamp_range: u32::max_value(),
1005 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
1009 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
1013 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
1017 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
1021 fn provided_node_features(&self) -> NodeFeatures {
1022 let mut features = NodeFeatures::empty();
1023 features.set_gossip_queries_optional();
1027 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
1028 let mut features = InitFeatures::empty();
1029 features.set_gossip_queries_optional();
1033 fn processing_queue_high(&self) -> bool { false }
1036 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
1037 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
1038 let mut ret = Vec::new();
1039 let mut pending_events = self.pending_events.lock().unwrap();
1040 core::mem::swap(&mut ret, &mut pending_events);
1045 pub struct TestLogger {
1047 pub(crate) id: String,
1048 pub lines: Mutex<HashMap<(&'static str, String), usize>>,
1049 pub context: Mutex<HashMap<(&'static str, Option<PublicKey>, Option<ChannelId>), usize>>,
1053 pub fn new() -> TestLogger {
1054 Self::with_id("".to_owned())
1056 pub fn with_id(id: String) -> TestLogger {
1058 level: Level::Trace,
1060 lines: Mutex::new(new_hash_map()),
1061 context: Mutex::new(new_hash_map()),
1064 pub fn enable(&mut self, level: Level) {
1067 pub fn assert_log(&self, module: &str, line: String, count: usize) {
1068 let log_entries = self.lines.lock().unwrap();
1069 assert_eq!(log_entries.get(&(module, line)), Some(&count));
1072 /// Search for the number of occurrence of the logged lines which
1073 /// 1. belongs to the specified module and
1074 /// 2. contains `line` in it.
1075 /// And asserts if the number of occurrences is the same with the given `count`
1076 pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
1077 let log_entries = self.lines.lock().unwrap();
1078 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1079 *m == module && l.contains(line)
1080 }).map(|(_, c) | { c }).sum();
1081 assert_eq!(l, count)
1084 /// Search for the number of occurrences of logged lines which
1085 /// 1. belong to the specified module and
1086 /// 2. match the given regex pattern.
1087 /// Assert that the number of occurrences equals the given `count`
1088 #[cfg(any(test, feature = "_test_utils"))]
1089 pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
1090 let log_entries = self.lines.lock().unwrap();
1091 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1092 *m == module && pattern.is_match(&l)
1093 }).map(|(_, c) | { c }).sum();
1094 assert_eq!(l, count)
1097 pub fn assert_log_context_contains(
1098 &self, module: &str, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>, count: usize
1100 let context_entries = self.context.lock().unwrap();
1101 let l = context_entries.get(&(module, peer_id, channel_id)).unwrap();
1102 assert_eq!(*l, count)
1106 impl Logger for TestLogger {
1107 fn log(&self, record: Record) {
1108 *self.lines.lock().unwrap().entry((record.module_path, format!("{}", record.args))).or_insert(0) += 1;
1109 *self.context.lock().unwrap().entry((record.module_path, record.peer_id, record.channel_id)).or_insert(0) += 1;
1110 if record.level >= self.level {
1111 #[cfg(all(not(ldk_bench), feature = "std"))] {
1112 let pfx = format!("{} {} [{}:{}]", self.id, record.level.to_string(), record.module_path, record.line);
1113 println!("{:<55}{}", pfx, record.args);
1119 pub struct TestNodeSigner {
1120 node_secret: SecretKey,
1123 impl TestNodeSigner {
1124 pub fn new(node_secret: SecretKey) -> Self {
1125 Self { node_secret }
1129 impl NodeSigner for TestNodeSigner {
1130 fn get_inbound_payment_key_material(&self) -> crate::sign::KeyMaterial {
1134 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1135 let node_secret = match recipient {
1136 Recipient::Node => Ok(&self.node_secret),
1137 Recipient::PhantomNode => Err(())
1139 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
1142 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
1143 let mut node_secret = match recipient {
1144 Recipient::Node => Ok(self.node_secret.clone()),
1145 Recipient::PhantomNode => Err(())
1147 if let Some(tweak) = tweak {
1148 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1150 Ok(SharedSecret::new(other_key, &node_secret))
1153 fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
1157 fn sign_bolt12_invoice_request(
1158 &self, _invoice_request: &UnsignedInvoiceRequest
1159 ) -> Result<schnorr::Signature, ()> {
1163 fn sign_bolt12_invoice(
1164 &self, _invoice: &UnsignedBolt12Invoice,
1165 ) -> Result<schnorr::Signature, ()> {
1169 fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1174 pub struct TestKeysInterface {
1175 pub backing: sign::PhantomKeysManager,
1176 pub override_random_bytes: Mutex<Option<[u8; 32]>>,
1177 pub disable_revocation_policy_check: bool,
1178 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
1179 expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
1180 pub unavailable_signers: Mutex<HashSet<[u8; 32]>>,
1183 impl EntropySource for TestKeysInterface {
1184 fn get_secure_random_bytes(&self) -> [u8; 32] {
1185 let override_random_bytes = self.override_random_bytes.lock().unwrap();
1186 if let Some(bytes) = &*override_random_bytes {
1189 self.backing.get_secure_random_bytes()
1193 impl NodeSigner for TestKeysInterface {
1194 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1195 self.backing.get_node_id(recipient)
1198 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1199 self.backing.ecdh(recipient, other_key, tweak)
1202 fn get_inbound_payment_key_material(&self) -> sign::KeyMaterial {
1203 self.backing.get_inbound_payment_key_material()
1206 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1207 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
1210 fn sign_bolt12_invoice_request(
1211 &self, invoice_request: &UnsignedInvoiceRequest
1212 ) -> Result<schnorr::Signature, ()> {
1213 self.backing.sign_bolt12_invoice_request(invoice_request)
1216 fn sign_bolt12_invoice(
1217 &self, invoice: &UnsignedBolt12Invoice,
1218 ) -> Result<schnorr::Signature, ()> {
1219 self.backing.sign_bolt12_invoice(invoice)
1222 fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1223 self.backing.sign_gossip_message(msg)
1227 impl SignerProvider for TestKeysInterface {
1228 type EcdsaSigner = TestChannelSigner;
1230 type TaprootSigner = TestChannelSigner;
1232 fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1233 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1236 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> TestChannelSigner {
1237 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
1238 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1239 let signer = TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check);
1240 if self.unavailable_signers.lock().unwrap().contains(&channel_keys_id) {
1241 signer.set_available(false);
1246 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
1247 let mut reader = io::Cursor::new(buffer);
1249 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
1250 let state = self.make_enforcement_state_cell(inner.commitment_seed);
1252 Ok(TestChannelSigner::new_with_revoked(
1255 self.disable_revocation_policy_check
1259 fn get_destination_script(&self, channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { self.backing.get_destination_script(channel_keys_id) }
1261 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1262 match &mut *self.expectations.lock().unwrap() {
1263 None => self.backing.get_shutdown_scriptpubkey(),
1264 Some(expectations) => match expectations.pop_front() {
1265 None => panic!("Unexpected get_shutdown_scriptpubkey"),
1266 Some(expectation) => Ok(expectation.returns),
1272 impl TestKeysInterface {
1273 pub fn new(seed: &[u8; 32], network: Network) -> Self {
1274 let now = Duration::from_secs(genesis_block(network).header.time as u64);
1276 backing: sign::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
1277 override_random_bytes: Mutex::new(None),
1278 disable_revocation_policy_check: false,
1279 enforcement_states: Mutex::new(new_hash_map()),
1280 expectations: Mutex::new(None),
1281 unavailable_signers: Mutex::new(new_hash_set()),
1285 /// Sets an expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] is
1287 pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
1288 self.expectations.lock().unwrap()
1289 .get_or_insert_with(|| VecDeque::new())
1290 .push_back(expectation);
1294 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> TestChannelSigner {
1295 self.derive_channel_signer(channel_value_satoshis, *id)
1298 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
1299 let mut states = self.enforcement_states.lock().unwrap();
1300 if !states.contains_key(&commitment_seed) {
1301 let state = EnforcementState::new();
1302 states.insert(commitment_seed, Arc::new(Mutex::new(state)));
1304 let cell = states.get(&commitment_seed).unwrap();
1309 pub(crate) fn panicking() -> bool {
1310 #[cfg(feature = "std")]
1311 let panicking = ::std::thread::panicking();
1312 #[cfg(not(feature = "std"))]
1313 let panicking = false;
1317 impl Drop for TestKeysInterface {
1318 fn drop(&mut self) {
1323 if let Some(expectations) = &*self.expectations.lock().unwrap() {
1324 if !expectations.is_empty() {
1325 panic!("Unsatisfied expectations: {:?}", expectations);
1331 /// An expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] was called and
1332 /// returns a [`ShutdownScript`].
1333 pub struct OnGetShutdownScriptpubkey {
1334 /// A shutdown script used to close a channel.
1335 pub returns: ShutdownScript,
1338 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
1339 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
1340 f.debug_struct("OnGetShutdownScriptpubkey").finish()
1344 pub struct TestChainSource {
1345 pub chain_hash: ChainHash,
1346 pub utxo_ret: Mutex<UtxoResult>,
1347 pub get_utxo_call_count: AtomicUsize,
1348 pub watched_txn: Mutex<HashSet<(Txid, ScriptBuf)>>,
1349 pub watched_outputs: Mutex<HashSet<(OutPoint, ScriptBuf)>>,
1352 impl TestChainSource {
1353 pub fn new(network: Network) -> Self {
1354 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1356 chain_hash: ChainHash::using_genesis_block(network),
1357 utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
1358 get_utxo_call_count: AtomicUsize::new(0),
1359 watched_txn: Mutex::new(new_hash_set()),
1360 watched_outputs: Mutex::new(new_hash_set()),
1365 impl UtxoLookup for TestChainSource {
1366 fn get_utxo(&self, chain_hash: &ChainHash, _short_channel_id: u64) -> UtxoResult {
1367 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
1368 if self.chain_hash != *chain_hash {
1369 return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
1372 self.utxo_ret.lock().unwrap().clone()
1376 impl chain::Filter for TestChainSource {
1377 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
1378 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.into()));
1381 fn register_output(&self, output: WatchedOutput) {
1382 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
1386 impl Drop for TestChainSource {
1387 fn drop(&mut self) {
1394 pub struct TestScorer {
1395 /// Stores a tuple of (scid, ChannelUsage)
1396 scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
1400 pub fn new() -> Self {
1402 scorer_expectations: RefCell::new(None),
1406 pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
1407 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
1412 impl crate::util::ser::Writeable for TestScorer {
1413 fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
1416 impl ScoreLookUp for TestScorer {
1417 type ScoreParams = ();
1418 fn channel_penalty_msat(
1419 &self, candidate: &CandidateRouteHop, usage: ChannelUsage, _score_params: &Self::ScoreParams
1421 let short_channel_id = match candidate.globally_unique_short_channel_id() {
1425 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
1426 match scorer_expectations.pop_front() {
1427 Some((scid, expectation)) => {
1428 assert_eq!(expectation, usage);
1429 assert_eq!(scid, short_channel_id);
1438 impl ScoreUpdate for TestScorer {
1439 fn payment_path_failed(&mut self, _actual_path: &Path, _actual_short_channel_id: u64, _duration_since_epoch: Duration) {}
1441 fn payment_path_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1443 fn probe_failed(&mut self, _actual_path: &Path, _: u64, _duration_since_epoch: Duration) {}
1445 fn probe_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1447 fn time_passed(&mut self, _duration_since_epoch: Duration) {}
1451 impl crate::routing::scoring::Score for TestScorer {}
1453 impl Drop for TestScorer {
1454 fn drop(&mut self) {
1455 #[cfg(feature = "std")] {
1456 if std::thread::panicking() {
1461 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
1462 if !scorer_expectations.is_empty() {
1463 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
1469 pub struct TestWalletSource {
1470 secret_key: SecretKey,
1471 utxos: RefCell<Vec<Utxo>>,
1472 secp: Secp256k1<bitcoin::secp256k1::All>,
1475 impl TestWalletSource {
1476 pub fn new(secret_key: SecretKey) -> Self {
1479 utxos: RefCell::new(Vec::new()),
1480 secp: Secp256k1::new(),
1484 pub fn add_utxo(&self, outpoint: bitcoin::OutPoint, value: u64) -> TxOut {
1485 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1486 let utxo = Utxo::new_p2pkh(outpoint, value, &public_key.pubkey_hash());
1487 self.utxos.borrow_mut().push(utxo.clone());
1491 pub fn add_custom_utxo(&self, utxo: Utxo) -> TxOut {
1492 let output = utxo.output.clone();
1493 self.utxos.borrow_mut().push(utxo);
1497 pub fn remove_utxo(&self, outpoint: bitcoin::OutPoint) {
1498 self.utxos.borrow_mut().retain(|utxo| utxo.outpoint != outpoint);
1502 impl WalletSource for TestWalletSource {
1503 fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()> {
1504 Ok(self.utxos.borrow().clone())
1507 fn get_change_script(&self) -> Result<ScriptBuf, ()> {
1508 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1509 Ok(ScriptBuf::new_p2pkh(&public_key.pubkey_hash()))
1512 fn sign_psbt(&self, psbt: PartiallySignedTransaction) -> Result<Transaction, ()> {
1513 let mut tx = psbt.extract_tx();
1514 let utxos = self.utxos.borrow();
1515 for i in 0..tx.input.len() {
1516 if let Some(utxo) = utxos.iter().find(|utxo| utxo.outpoint == tx.input[i].previous_output) {
1517 let sighash = SighashCache::new(&tx)
1518 .legacy_signature_hash(i, &utxo.output.script_pubkey, EcdsaSighashType::All as u32)
1520 let sig = self.secp.sign_ecdsa(&(*sighash.as_raw_hash()).into(), &self.secret_key);
1521 let bitcoin_sig = bitcoin::ecdsa::Signature { sig, hash_ty: EcdsaSighashType::All };
1522 tx.input[i].script_sig = Builder::new()
1523 .push_slice(&bitcoin_sig.serialize())
1524 .push_slice(&self.secret_key.public_key(&self.secp).serialize())