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> {
146 if let Some((find_route_query, find_route_res)) = self.next_routes.lock().unwrap().pop_front() {
147 assert_eq!(find_route_query, *params);
148 if let Ok(ref route) = find_route_res {
149 assert_eq!(route.route_params, Some(find_route_query));
150 let scorer = self.scorer.read().unwrap();
151 let scorer = ScorerAccountingForInFlightHtlcs::new(scorer, &inflight_htlcs);
152 for path in &route.paths {
153 let mut aggregate_msat = 0u64;
154 let mut prev_hop_node = payer;
155 for (idx, hop) in path.hops.iter().rev().enumerate() {
156 aggregate_msat += hop.fee_msat;
157 let usage = ChannelUsage {
158 amount_msat: aggregate_msat,
159 inflight_htlc_msat: 0,
160 effective_capacity: EffectiveCapacity::Unknown,
163 if idx == path.hops.len() - 1 {
164 if let Some(first_hops) = first_hops {
165 if let Some(idx) = first_hops.iter().position(|h| h.get_outbound_payment_scid() == Some(hop.short_channel_id)) {
166 let node_id = NodeId::from_pubkey(payer);
167 let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
168 details: first_hops[idx],
169 payer_node_id: &node_id,
171 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
176 let network_graph = self.network_graph.read_only();
177 if let Some(channel) = network_graph.channel(hop.short_channel_id) {
178 let (directed, _) = channel.as_directed_to(&NodeId::from_pubkey(&hop.pubkey)).unwrap();
179 let candidate = CandidateRouteHop::PublicHop(PublicHopCandidate {
181 short_channel_id: hop.short_channel_id,
183 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
185 let target_node_id = NodeId::from_pubkey(&hop.pubkey);
186 let route_hint = RouteHintHop {
187 src_node_id: *prev_hop_node,
188 short_channel_id: hop.short_channel_id,
189 fees: RoutingFees { base_msat: 0, proportional_millionths: 0 },
190 cltv_expiry_delta: 0,
191 htlc_minimum_msat: None,
192 htlc_maximum_msat: None,
194 let candidate = CandidateRouteHop::PrivateHop(PrivateHopCandidate {
196 target_node_id: &target_node_id,
198 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
200 prev_hop_node = &hop.pubkey;
204 return find_route_res;
207 self.router.find_route(payer, params, first_hops, inflight_htlcs)
210 fn create_blinded_payment_paths<
211 T: secp256k1::Signing + secp256k1::Verification
213 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
214 amount_msats: u64, secp_ctx: &Secp256k1<T>,
215 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
216 self.router.create_blinded_payment_paths(
217 recipient, first_hops, tlvs, amount_msats, secp_ctx
222 impl<'a> MessageRouter for TestRouter<'a> {
224 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
225 ) -> Result<OnionMessagePath, ()> {
226 self.router.find_path(sender, peers, destination)
229 fn create_blinded_paths<
230 T: secp256k1::Signing + secp256k1::Verification
232 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
233 ) -> Result<Vec<BlindedPath>, ()> {
234 self.router.create_blinded_paths(recipient, peers, secp_ctx)
238 impl<'a> Drop for TestRouter<'a> {
240 #[cfg(feature = "std")] {
241 if std::thread::panicking() {
245 assert!(self.next_routes.lock().unwrap().is_empty());
249 pub struct TestMessageRouter<'a> {
250 inner: DefaultMessageRouter<Arc<NetworkGraph<&'a TestLogger>>, &'a TestLogger, &'a TestKeysInterface>,
253 impl<'a> TestMessageRouter<'a> {
254 pub fn new(network_graph: Arc<NetworkGraph<&'a TestLogger>>, entropy_source: &'a TestKeysInterface) -> Self {
255 Self { inner: DefaultMessageRouter::new(network_graph, entropy_source) }
259 impl<'a> MessageRouter for TestMessageRouter<'a> {
261 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
262 ) -> Result<OnionMessagePath, ()> {
263 self.inner.find_path(sender, peers, destination)
266 fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
267 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
268 ) -> Result<Vec<BlindedPath>, ()> {
269 self.inner.create_blinded_paths(recipient, peers, secp_ctx)
273 pub struct OnlyReadsKeysInterface {}
275 impl EntropySource for OnlyReadsKeysInterface {
276 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
278 impl SignerProvider for OnlyReadsKeysInterface {
279 type EcdsaSigner = TestChannelSigner;
281 type TaprootSigner = TestChannelSigner;
283 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
285 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner { unreachable!(); }
287 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
288 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
289 let state = Arc::new(Mutex::new(EnforcementState::new()));
291 Ok(TestChannelSigner::new_with_revoked(
298 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { Err(()) }
299 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { Err(()) }
302 pub struct TestChainMonitor<'a> {
303 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<TestChannelSigner>)>>,
304 pub monitor_updates: Mutex<HashMap<ChannelId, Vec<channelmonitor::ChannelMonitorUpdate>>>,
305 pub latest_monitor_update_id: Mutex<HashMap<ChannelId, (OutPoint, u64, MonitorUpdateId)>>,
306 pub chain_monitor: chainmonitor::ChainMonitor<TestChannelSigner, &'a TestChainSource, &'a dyn chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a dyn chainmonitor::Persist<TestChannelSigner>>,
307 pub keys_manager: &'a TestKeysInterface,
308 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
309 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
311 pub expect_channel_force_closed: Mutex<Option<(ChannelId, bool)>>,
312 /// If this is set to Some(), the next round trip serialization check will not hold after an
313 /// update_channel call (not watch_channel) for the given channel_id.
314 pub expect_monitor_round_trip_fail: Mutex<Option<ChannelId>>,
316 impl<'a> TestChainMonitor<'a> {
317 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 {
319 added_monitors: Mutex::new(Vec::new()),
320 monitor_updates: Mutex::new(new_hash_map()),
321 latest_monitor_update_id: Mutex::new(new_hash_map()),
322 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
324 expect_channel_force_closed: Mutex::new(None),
325 expect_monitor_round_trip_fail: Mutex::new(None),
329 pub fn complete_sole_pending_chan_update(&self, channel_id: &ChannelId) {
330 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
331 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
334 impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {
335 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
336 // At every point where we get a monitor update, we should be able to send a useful monitor
337 // to a watchtower and disk...
338 let mut w = TestVecWriter(Vec::new());
339 monitor.write(&mut w).unwrap();
340 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
341 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
342 assert!(new_monitor == monitor);
343 self.latest_monitor_update_id.lock().unwrap().insert(monitor.channel_id(),
344 (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
345 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
346 self.chain_monitor.watch_channel(funding_txo, new_monitor)
349 fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
350 // Every monitor update should survive roundtrip
351 let mut w = TestVecWriter(Vec::new());
352 update.write(&mut w).unwrap();
353 assert!(channelmonitor::ChannelMonitorUpdate::read(
354 &mut io::Cursor::new(&w.0)).unwrap() == *update);
355 let channel_id = update.channel_id.unwrap_or(ChannelId::v1_from_funding_outpoint(funding_txo));
357 self.monitor_updates.lock().unwrap().entry(channel_id).or_insert(Vec::new()).push(update.clone());
359 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
360 assert_eq!(channel_id, exp.0);
361 assert_eq!(update.updates.len(), 1);
362 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
363 assert_eq!(should_broadcast, exp.1);
367 self.latest_monitor_update_id.lock().unwrap().insert(channel_id,
368 (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(update)));
369 let update_res = self.chain_monitor.update_channel(funding_txo, update);
370 // At every point where we get a monitor update, we should be able to send a useful monitor
371 // to a watchtower and disk...
372 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
374 monitor.write(&mut w).unwrap();
375 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
376 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
377 if let Some(chan_id) = self.expect_monitor_round_trip_fail.lock().unwrap().take() {
378 assert_eq!(chan_id, channel_id);
379 assert!(new_monitor != *monitor);
381 assert!(new_monitor == *monitor);
383 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
387 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, Option<PublicKey>)> {
388 return self.chain_monitor.release_pending_monitor_events();
392 struct JusticeTxData {
393 justice_tx: Transaction,
395 commitment_number: u64,
398 pub(crate) struct WatchtowerPersister {
399 persister: TestPersister,
400 /// Upon a new commitment_signed, we'll get a
401 /// ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTxInfo. We'll store the justice tx
402 /// amount, and commitment number so we can build the justice tx after our counterparty
404 unsigned_justice_tx_data: Mutex<HashMap<OutPoint, VecDeque<JusticeTxData>>>,
405 /// After receiving a revoke_and_ack for a commitment number, we'll form and store the justice
406 /// tx which would be used to provide a watchtower with the data it needs.
407 watchtower_state: Mutex<HashMap<OutPoint, HashMap<Txid, Transaction>>>,
408 destination_script: ScriptBuf,
411 impl WatchtowerPersister {
413 pub(crate) fn new(destination_script: ScriptBuf) -> Self {
414 WatchtowerPersister {
415 persister: TestPersister::new(),
416 unsigned_justice_tx_data: Mutex::new(new_hash_map()),
417 watchtower_state: Mutex::new(new_hash_map()),
423 pub(crate) fn justice_tx(&self, funding_txo: OutPoint, commitment_txid: &Txid)
424 -> Option<Transaction> {
425 self.watchtower_state.lock().unwrap().get(&funding_txo).unwrap().get(commitment_txid).cloned()
428 fn form_justice_data_from_commitment(&self, counterparty_commitment_tx: &CommitmentTransaction)
429 -> Option<JusticeTxData> {
430 let trusted_tx = counterparty_commitment_tx.trust();
431 let output_idx = trusted_tx.revokeable_output_index()?;
432 let built_tx = trusted_tx.built_transaction();
433 let value = built_tx.transaction.output[output_idx as usize].value;
434 let justice_tx = trusted_tx.build_to_local_justice_tx(
435 FEERATE_FLOOR_SATS_PER_KW as u64, self.destination_script.clone()).ok()?;
436 let commitment_number = counterparty_commitment_tx.commitment_number();
437 Some(JusticeTxData { justice_tx, value, commitment_number })
441 impl<Signer: sign::ecdsa::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for WatchtowerPersister {
442 fn persist_new_channel(&self, funding_txo: OutPoint,
443 data: &channelmonitor::ChannelMonitor<Signer>, id: MonitorUpdateId
444 ) -> chain::ChannelMonitorUpdateStatus {
445 let res = self.persister.persist_new_channel(funding_txo, data, id);
447 assert!(self.unsigned_justice_tx_data.lock().unwrap()
448 .insert(funding_txo, VecDeque::new()).is_none());
449 assert!(self.watchtower_state.lock().unwrap()
450 .insert(funding_txo, new_hash_map()).is_none());
452 let initial_counterparty_commitment_tx = data.initial_counterparty_commitment_tx()
453 .expect("First and only call expects Some");
454 if let Some(justice_data)
455 = self.form_justice_data_from_commitment(&initial_counterparty_commitment_tx) {
456 self.unsigned_justice_tx_data.lock().unwrap()
457 .get_mut(&funding_txo).unwrap()
458 .push_back(justice_data);
463 fn update_persisted_channel(
464 &self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>,
465 data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId
466 ) -> chain::ChannelMonitorUpdateStatus {
467 let res = self.persister.update_persisted_channel(funding_txo, update, data, update_id);
469 if let Some(update) = update {
470 let commitment_txs = data.counterparty_commitment_txs_from_update(update);
471 let justice_datas = commitment_txs.into_iter()
472 .filter_map(|commitment_tx| self.form_justice_data_from_commitment(&commitment_tx));
473 let mut channels_justice_txs = self.unsigned_justice_tx_data.lock().unwrap();
474 let channel_state = channels_justice_txs.get_mut(&funding_txo).unwrap();
475 channel_state.extend(justice_datas);
477 while let Some(JusticeTxData { justice_tx, value, commitment_number }) = channel_state.front() {
479 let commitment_txid = justice_tx.input[input_idx].previous_output.txid;
480 match data.sign_to_local_justice_tx(justice_tx.clone(), input_idx, *value, *commitment_number) {
481 Ok(signed_justice_tx) => {
482 let dup = self.watchtower_state.lock().unwrap()
483 .get_mut(&funding_txo).unwrap()
484 .insert(commitment_txid, signed_justice_tx);
485 assert!(dup.is_none());
486 channel_state.pop_front();
496 pub struct TestPersister {
497 /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
499 pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
500 /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
501 /// MonitorUpdateId here.
502 pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
503 /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
504 /// MonitorUpdateId here.
505 pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
508 pub fn new() -> Self {
510 update_rets: Mutex::new(VecDeque::new()),
511 chain_sync_monitor_persistences: Mutex::new(new_hash_map()),
512 offchain_monitor_updates: Mutex::new(new_hash_map()),
516 /// Queue an update status to return.
517 pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
518 self.update_rets.lock().unwrap().push_back(next_ret);
521 impl<Signer: sign::ecdsa::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
522 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
523 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
526 chain::ChannelMonitorUpdateStatus::Completed
529 fn update_persisted_channel(&self, funding_txo: OutPoint, _update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
530 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
531 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
534 let is_chain_sync = if let UpdateOrigin::ChainSync(_) = update_id.contents { true } else { false };
536 self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(new_hash_set()).insert(update_id);
538 self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(new_hash_set()).insert(update_id);
544 pub struct TestStore {
545 persisted_bytes: Mutex<HashMap<String, HashMap<String, Vec<u8>>>>,
550 pub fn new(read_only: bool) -> Self {
551 let persisted_bytes = Mutex::new(new_hash_map());
552 Self { persisted_bytes, read_only }
556 impl KVStore for TestStore {
557 fn read(&self, primary_namespace: &str, secondary_namespace: &str, key: &str) -> io::Result<Vec<u8>> {
558 let persisted_lock = self.persisted_bytes.lock().unwrap();
559 let prefixed = if secondary_namespace.is_empty() {
560 primary_namespace.to_string()
562 format!("{}/{}", primary_namespace, secondary_namespace)
565 if let Some(outer_ref) = persisted_lock.get(&prefixed) {
566 if let Some(inner_ref) = outer_ref.get(key) {
567 let bytes = inner_ref.clone();
570 Err(io::Error::new(io::ErrorKind::NotFound, "Key not found"))
573 Err(io::Error::new(io::ErrorKind::NotFound, "Namespace not found"))
577 fn write(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: &[u8]) -> io::Result<()> {
579 return Err(io::Error::new(
580 io::ErrorKind::PermissionDenied,
581 "Cannot modify read-only store",
584 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
586 let prefixed = if secondary_namespace.is_empty() {
587 primary_namespace.to_string()
589 format!("{}/{}", primary_namespace, secondary_namespace)
591 let outer_e = persisted_lock.entry(prefixed).or_insert(new_hash_map());
592 let mut bytes = Vec::new();
593 bytes.write_all(buf)?;
594 outer_e.insert(key.to_string(), bytes);
598 fn remove(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, _lazy: bool) -> io::Result<()> {
600 return Err(io::Error::new(
601 io::ErrorKind::PermissionDenied,
602 "Cannot modify read-only store",
606 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
608 let prefixed = if secondary_namespace.is_empty() {
609 primary_namespace.to_string()
611 format!("{}/{}", primary_namespace, secondary_namespace)
613 if let Some(outer_ref) = persisted_lock.get_mut(&prefixed) {
614 outer_ref.remove(&key.to_string());
620 fn list(&self, primary_namespace: &str, secondary_namespace: &str) -> io::Result<Vec<String>> {
621 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
623 let prefixed = if secondary_namespace.is_empty() {
624 primary_namespace.to_string()
626 format!("{}/{}", primary_namespace, secondary_namespace)
628 match persisted_lock.entry(prefixed) {
629 hash_map::Entry::Occupied(e) => Ok(e.get().keys().cloned().collect()),
630 hash_map::Entry::Vacant(_) => Ok(Vec::new()),
635 unsafe impl Sync for TestStore {}
636 unsafe impl Send for TestStore {}
638 pub struct TestBroadcaster {
639 pub txn_broadcasted: Mutex<Vec<Transaction>>,
640 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
643 impl TestBroadcaster {
644 pub fn new(network: Network) -> Self {
646 txn_broadcasted: Mutex::new(Vec::new()),
647 blocks: Arc::new(Mutex::new(vec![(genesis_block(network), 0)])),
651 pub fn with_blocks(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> Self {
652 Self { txn_broadcasted: Mutex::new(Vec::new()), blocks }
655 pub fn txn_broadcast(&self) -> Vec<Transaction> {
656 self.txn_broadcasted.lock().unwrap().split_off(0)
659 pub fn unique_txn_broadcast(&self) -> Vec<Transaction> {
660 let mut txn = self.txn_broadcasted.lock().unwrap().split_off(0);
661 let mut seen = new_hash_set();
662 txn.retain(|tx| seen.insert(tx.txid()));
667 impl chaininterface::BroadcasterInterface for TestBroadcaster {
668 fn broadcast_transactions(&self, txs: &[&Transaction]) {
670 let lock_time = tx.lock_time.to_consensus_u32();
671 assert!(lock_time < 1_500_000_000);
672 if tx.lock_time.is_block_height() && lock_time > self.blocks.lock().unwrap().last().unwrap().1 {
673 for inp in tx.input.iter() {
674 if inp.sequence != Sequence::MAX {
675 panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
680 let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
681 self.txn_broadcasted.lock().unwrap().extend(owned_txs);
685 pub struct TestChannelMessageHandler {
686 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
687 expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
688 connected_peers: Mutex<HashSet<PublicKey>>,
689 pub message_fetch_counter: AtomicUsize,
690 chain_hash: ChainHash,
693 impl TestChannelMessageHandler {
694 pub fn new(chain_hash: ChainHash) -> Self {
695 TestChannelMessageHandler {
696 pending_events: Mutex::new(Vec::new()),
697 expected_recv_msgs: Mutex::new(None),
698 connected_peers: Mutex::new(new_hash_set()),
699 message_fetch_counter: AtomicUsize::new(0),
705 pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
706 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
707 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
708 expected_msgs.as_mut().unwrap().push(ev);
711 fn received_msg(&self, _ev: wire::Message<()>) {
712 let mut msgs = self.expected_recv_msgs.lock().unwrap();
713 if msgs.is_none() { return; }
714 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
716 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
717 msgs.as_mut().unwrap().remove(0);
721 impl Drop for TestChannelMessageHandler {
723 #[cfg(feature = "std")]
725 let l = self.expected_recv_msgs.lock().unwrap();
726 if !std::thread::panicking() {
727 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
733 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
734 fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
735 self.received_msg(wire::Message::OpenChannel(msg.clone()));
737 fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
738 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
740 fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
741 self.received_msg(wire::Message::FundingCreated(msg.clone()));
743 fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
744 self.received_msg(wire::Message::FundingSigned(msg.clone()));
746 fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
747 self.received_msg(wire::Message::ChannelReady(msg.clone()));
749 fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
750 self.received_msg(wire::Message::Shutdown(msg.clone()));
752 fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
753 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
755 fn handle_stfu(&self, _their_node_id: &PublicKey, msg: &msgs::Stfu) {
756 self.received_msg(wire::Message::Stfu(msg.clone()));
758 fn handle_splice(&self, _their_node_id: &PublicKey, msg: &msgs::Splice) {
759 self.received_msg(wire::Message::Splice(msg.clone()));
761 fn handle_splice_ack(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
762 self.received_msg(wire::Message::SpliceAck(msg.clone()));
764 fn handle_splice_locked(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
765 self.received_msg(wire::Message::SpliceLocked(msg.clone()));
767 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
768 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
770 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
771 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
773 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
774 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
776 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
777 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
779 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
780 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
782 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
783 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
785 fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
786 self.received_msg(wire::Message::UpdateFee(msg.clone()));
788 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
789 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
791 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
792 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
794 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
795 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
797 fn peer_disconnected(&self, their_node_id: &PublicKey) {
798 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
800 fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
801 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
802 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
803 // bother re-generating the expected Init message in all tests.
806 fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
807 self.received_msg(wire::Message::Error(msg.clone()));
809 fn provided_node_features(&self) -> NodeFeatures {
810 channelmanager::provided_node_features(&UserConfig::default())
812 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
813 channelmanager::provided_init_features(&UserConfig::default())
816 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
817 Some(vec![self.chain_hash])
820 fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
821 self.received_msg(wire::Message::OpenChannelV2(msg.clone()));
824 fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
825 self.received_msg(wire::Message::AcceptChannelV2(msg.clone()));
828 fn handle_tx_add_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
829 self.received_msg(wire::Message::TxAddInput(msg.clone()));
832 fn handle_tx_add_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
833 self.received_msg(wire::Message::TxAddOutput(msg.clone()));
836 fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
837 self.received_msg(wire::Message::TxRemoveInput(msg.clone()));
840 fn handle_tx_remove_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
841 self.received_msg(wire::Message::TxRemoveOutput(msg.clone()));
844 fn handle_tx_complete(&self, _their_node_id: &PublicKey, msg: &msgs::TxComplete) {
845 self.received_msg(wire::Message::TxComplete(msg.clone()));
848 fn handle_tx_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
849 self.received_msg(wire::Message::TxSignatures(msg.clone()));
852 fn handle_tx_init_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
853 self.received_msg(wire::Message::TxInitRbf(msg.clone()));
856 fn handle_tx_ack_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
857 self.received_msg(wire::Message::TxAckRbf(msg.clone()));
860 fn handle_tx_abort(&self, _their_node_id: &PublicKey, msg: &msgs::TxAbort) {
861 self.received_msg(wire::Message::TxAbort(msg.clone()));
865 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
866 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
867 self.message_fetch_counter.fetch_add(1, Ordering::AcqRel);
868 let mut pending_events = self.pending_events.lock().unwrap();
869 let mut ret = Vec::new();
870 mem::swap(&mut ret, &mut *pending_events);
875 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
876 use bitcoin::secp256k1::ffi::Signature as FFISignature;
877 let secp_ctx = Secp256k1::new();
878 let network = Network::Testnet;
879 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
880 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
881 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
882 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
883 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
884 features: ChannelFeatures::empty(),
885 chain_hash: ChainHash::using_genesis_block(network),
886 short_channel_id: short_chan_id,
887 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
888 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
889 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
890 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
891 excess_data: Vec::new(),
895 msgs::ChannelAnnouncement {
896 node_signature_1: Signature::from(FFISignature::new()),
897 node_signature_2: Signature::from(FFISignature::new()),
898 bitcoin_signature_1: Signature::from(FFISignature::new()),
899 bitcoin_signature_2: Signature::from(FFISignature::new()),
900 contents: unsigned_ann,
905 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
906 use bitcoin::secp256k1::ffi::Signature as FFISignature;
907 let network = Network::Testnet;
908 msgs::ChannelUpdate {
909 signature: Signature::from(unsafe { FFISignature::new() }),
910 contents: msgs::UnsignedChannelUpdate {
911 chain_hash: ChainHash::using_genesis_block(network),
912 short_channel_id: short_chan_id,
915 cltv_expiry_delta: 0,
916 htlc_minimum_msat: 0,
917 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
919 fee_proportional_millionths: 0,
925 pub struct TestRoutingMessageHandler {
926 pub chan_upds_recvd: AtomicUsize,
927 pub chan_anns_recvd: AtomicUsize,
928 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
929 pub request_full_sync: AtomicBool,
932 impl TestRoutingMessageHandler {
933 pub fn new() -> Self {
934 TestRoutingMessageHandler {
935 chan_upds_recvd: AtomicUsize::new(0),
936 chan_anns_recvd: AtomicUsize::new(0),
937 pending_events: Mutex::new(vec![]),
938 request_full_sync: AtomicBool::new(false),
942 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
943 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
944 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
946 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
947 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
948 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
950 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
951 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
952 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
954 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
955 let chan_upd_1 = get_dummy_channel_update(starting_point);
956 let chan_upd_2 = get_dummy_channel_update(starting_point);
957 let chan_ann = get_dummy_channel_announcement(starting_point);
959 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
962 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
966 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
967 if !init_msg.features.supports_gossip_queries() {
971 #[allow(unused_mut, unused_assignments)]
972 let mut gossip_start_time = 0;
973 #[cfg(feature = "std")]
975 gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
976 if self.request_full_sync.load(Ordering::Acquire) {
977 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
979 gossip_start_time -= 60 * 60; // an hour ago
983 let mut pending_events = self.pending_events.lock().unwrap();
984 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
985 node_id: their_node_id.clone(),
986 msg: msgs::GossipTimestampFilter {
987 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
988 first_timestamp: gossip_start_time as u32,
989 timestamp_range: u32::max_value(),
995 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
999 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
1003 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
1007 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
1011 fn provided_node_features(&self) -> NodeFeatures {
1012 let mut features = NodeFeatures::empty();
1013 features.set_gossip_queries_optional();
1017 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
1018 let mut features = InitFeatures::empty();
1019 features.set_gossip_queries_optional();
1023 fn processing_queue_high(&self) -> bool { false }
1026 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
1027 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
1028 let mut ret = Vec::new();
1029 let mut pending_events = self.pending_events.lock().unwrap();
1030 core::mem::swap(&mut ret, &mut pending_events);
1035 pub struct TestLogger {
1037 pub(crate) id: String,
1038 pub lines: Mutex<HashMap<(&'static str, String), usize>>,
1039 pub context: Mutex<HashMap<(&'static str, Option<PublicKey>, Option<ChannelId>), usize>>,
1043 pub fn new() -> TestLogger {
1044 Self::with_id("".to_owned())
1046 pub fn with_id(id: String) -> TestLogger {
1048 level: Level::Trace,
1050 lines: Mutex::new(new_hash_map()),
1051 context: Mutex::new(new_hash_map()),
1054 pub fn enable(&mut self, level: Level) {
1057 pub fn assert_log(&self, module: &str, line: String, count: usize) {
1058 let log_entries = self.lines.lock().unwrap();
1059 assert_eq!(log_entries.get(&(module, line)), Some(&count));
1062 /// Search for the number of occurrence of the logged lines which
1063 /// 1. belongs to the specified module and
1064 /// 2. contains `line` in it.
1065 /// And asserts if the number of occurrences is the same with the given `count`
1066 pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
1067 let log_entries = self.lines.lock().unwrap();
1068 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1069 *m == module && l.contains(line)
1070 }).map(|(_, c) | { c }).sum();
1071 assert_eq!(l, count)
1074 /// Search for the number of occurrences of logged lines which
1075 /// 1. belong to the specified module and
1076 /// 2. match the given regex pattern.
1077 /// Assert that the number of occurrences equals the given `count`
1078 #[cfg(any(test, feature = "_test_utils"))]
1079 pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
1080 let log_entries = self.lines.lock().unwrap();
1081 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1082 *m == module && pattern.is_match(&l)
1083 }).map(|(_, c) | { c }).sum();
1084 assert_eq!(l, count)
1087 pub fn assert_log_context_contains(
1088 &self, module: &str, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>, count: usize
1090 let context_entries = self.context.lock().unwrap();
1091 let l = context_entries.get(&(module, peer_id, channel_id)).unwrap();
1092 assert_eq!(*l, count)
1096 impl Logger for TestLogger {
1097 fn log(&self, record: Record) {
1098 *self.lines.lock().unwrap().entry((record.module_path, format!("{}", record.args))).or_insert(0) += 1;
1099 *self.context.lock().unwrap().entry((record.module_path, record.peer_id, record.channel_id)).or_insert(0) += 1;
1100 if record.level >= self.level {
1101 #[cfg(all(not(ldk_bench), feature = "std"))] {
1102 let pfx = format!("{} {} [{}:{}]", self.id, record.level.to_string(), record.module_path, record.line);
1103 println!("{:<55}{}", pfx, record.args);
1109 pub struct TestNodeSigner {
1110 node_secret: SecretKey,
1113 impl TestNodeSigner {
1114 pub fn new(node_secret: SecretKey) -> Self {
1115 Self { node_secret }
1119 impl NodeSigner for TestNodeSigner {
1120 fn get_inbound_payment_key_material(&self) -> crate::sign::KeyMaterial {
1124 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1125 let node_secret = match recipient {
1126 Recipient::Node => Ok(&self.node_secret),
1127 Recipient::PhantomNode => Err(())
1129 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
1132 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
1133 let mut node_secret = match recipient {
1134 Recipient::Node => Ok(self.node_secret.clone()),
1135 Recipient::PhantomNode => Err(())
1137 if let Some(tweak) = tweak {
1138 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1140 Ok(SharedSecret::new(other_key, &node_secret))
1143 fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
1147 fn sign_bolt12_invoice_request(
1148 &self, _invoice_request: &UnsignedInvoiceRequest
1149 ) -> Result<schnorr::Signature, ()> {
1153 fn sign_bolt12_invoice(
1154 &self, _invoice: &UnsignedBolt12Invoice,
1155 ) -> Result<schnorr::Signature, ()> {
1159 fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1164 pub struct TestKeysInterface {
1165 pub backing: sign::PhantomKeysManager,
1166 pub override_random_bytes: Mutex<Option<[u8; 32]>>,
1167 pub disable_revocation_policy_check: bool,
1168 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
1169 expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
1172 impl EntropySource for TestKeysInterface {
1173 fn get_secure_random_bytes(&self) -> [u8; 32] {
1174 let override_random_bytes = self.override_random_bytes.lock().unwrap();
1175 if let Some(bytes) = &*override_random_bytes {
1178 self.backing.get_secure_random_bytes()
1182 impl NodeSigner for TestKeysInterface {
1183 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1184 self.backing.get_node_id(recipient)
1187 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1188 self.backing.ecdh(recipient, other_key, tweak)
1191 fn get_inbound_payment_key_material(&self) -> sign::KeyMaterial {
1192 self.backing.get_inbound_payment_key_material()
1195 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1196 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
1199 fn sign_bolt12_invoice_request(
1200 &self, invoice_request: &UnsignedInvoiceRequest
1201 ) -> Result<schnorr::Signature, ()> {
1202 self.backing.sign_bolt12_invoice_request(invoice_request)
1205 fn sign_bolt12_invoice(
1206 &self, invoice: &UnsignedBolt12Invoice,
1207 ) -> Result<schnorr::Signature, ()> {
1208 self.backing.sign_bolt12_invoice(invoice)
1211 fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1212 self.backing.sign_gossip_message(msg)
1216 impl SignerProvider for TestKeysInterface {
1217 type EcdsaSigner = TestChannelSigner;
1219 type TaprootSigner = TestChannelSigner;
1221 fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1222 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1225 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> TestChannelSigner {
1226 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
1227 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1228 TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
1231 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
1232 let mut reader = io::Cursor::new(buffer);
1234 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
1235 let state = self.make_enforcement_state_cell(inner.commitment_seed);
1237 Ok(TestChannelSigner::new_with_revoked(
1240 self.disable_revocation_policy_check
1244 fn get_destination_script(&self, channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { self.backing.get_destination_script(channel_keys_id) }
1246 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1247 match &mut *self.expectations.lock().unwrap() {
1248 None => self.backing.get_shutdown_scriptpubkey(),
1249 Some(expectations) => match expectations.pop_front() {
1250 None => panic!("Unexpected get_shutdown_scriptpubkey"),
1251 Some(expectation) => Ok(expectation.returns),
1257 impl TestKeysInterface {
1258 pub fn new(seed: &[u8; 32], network: Network) -> Self {
1259 let now = Duration::from_secs(genesis_block(network).header.time as u64);
1261 backing: sign::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
1262 override_random_bytes: Mutex::new(None),
1263 disable_revocation_policy_check: false,
1264 enforcement_states: Mutex::new(new_hash_map()),
1265 expectations: Mutex::new(None),
1269 /// Sets an expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] is
1271 pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
1272 self.expectations.lock().unwrap()
1273 .get_or_insert_with(|| VecDeque::new())
1274 .push_back(expectation);
1278 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> TestChannelSigner {
1279 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
1280 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1281 TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
1284 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
1285 let mut states = self.enforcement_states.lock().unwrap();
1286 if !states.contains_key(&commitment_seed) {
1287 let state = EnforcementState::new();
1288 states.insert(commitment_seed, Arc::new(Mutex::new(state)));
1290 let cell = states.get(&commitment_seed).unwrap();
1295 pub(crate) fn panicking() -> bool {
1296 #[cfg(feature = "std")]
1297 let panicking = ::std::thread::panicking();
1298 #[cfg(not(feature = "std"))]
1299 let panicking = false;
1303 impl Drop for TestKeysInterface {
1304 fn drop(&mut self) {
1309 if let Some(expectations) = &*self.expectations.lock().unwrap() {
1310 if !expectations.is_empty() {
1311 panic!("Unsatisfied expectations: {:?}", expectations);
1317 /// An expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] was called and
1318 /// returns a [`ShutdownScript`].
1319 pub struct OnGetShutdownScriptpubkey {
1320 /// A shutdown script used to close a channel.
1321 pub returns: ShutdownScript,
1324 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
1325 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
1326 f.debug_struct("OnGetShutdownScriptpubkey").finish()
1330 pub struct TestChainSource {
1331 pub chain_hash: ChainHash,
1332 pub utxo_ret: Mutex<UtxoResult>,
1333 pub get_utxo_call_count: AtomicUsize,
1334 pub watched_txn: Mutex<HashSet<(Txid, ScriptBuf)>>,
1335 pub watched_outputs: Mutex<HashSet<(OutPoint, ScriptBuf)>>,
1338 impl TestChainSource {
1339 pub fn new(network: Network) -> Self {
1340 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1342 chain_hash: ChainHash::using_genesis_block(network),
1343 utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
1344 get_utxo_call_count: AtomicUsize::new(0),
1345 watched_txn: Mutex::new(new_hash_set()),
1346 watched_outputs: Mutex::new(new_hash_set()),
1351 impl UtxoLookup for TestChainSource {
1352 fn get_utxo(&self, chain_hash: &ChainHash, _short_channel_id: u64) -> UtxoResult {
1353 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
1354 if self.chain_hash != *chain_hash {
1355 return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
1358 self.utxo_ret.lock().unwrap().clone()
1362 impl chain::Filter for TestChainSource {
1363 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
1364 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.into()));
1367 fn register_output(&self, output: WatchedOutput) {
1368 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
1372 impl Drop for TestChainSource {
1373 fn drop(&mut self) {
1380 pub struct TestScorer {
1381 /// Stores a tuple of (scid, ChannelUsage)
1382 scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
1386 pub fn new() -> Self {
1388 scorer_expectations: RefCell::new(None),
1392 pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
1393 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
1398 impl crate::util::ser::Writeable for TestScorer {
1399 fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
1402 impl ScoreLookUp for TestScorer {
1403 type ScoreParams = ();
1404 fn channel_penalty_msat(
1405 &self, candidate: &CandidateRouteHop, usage: ChannelUsage, _score_params: &Self::ScoreParams
1407 let short_channel_id = match candidate.globally_unique_short_channel_id() {
1411 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
1412 match scorer_expectations.pop_front() {
1413 Some((scid, expectation)) => {
1414 assert_eq!(expectation, usage);
1415 assert_eq!(scid, short_channel_id);
1424 impl ScoreUpdate for TestScorer {
1425 fn payment_path_failed(&mut self, _actual_path: &Path, _actual_short_channel_id: u64, _duration_since_epoch: Duration) {}
1427 fn payment_path_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1429 fn probe_failed(&mut self, _actual_path: &Path, _: u64, _duration_since_epoch: Duration) {}
1431 fn probe_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1433 fn time_passed(&mut self, _duration_since_epoch: Duration) {}
1437 impl crate::routing::scoring::Score for TestScorer {}
1439 impl Drop for TestScorer {
1440 fn drop(&mut self) {
1441 #[cfg(feature = "std")] {
1442 if std::thread::panicking() {
1447 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
1448 if !scorer_expectations.is_empty() {
1449 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
1455 pub struct TestWalletSource {
1456 secret_key: SecretKey,
1457 utxos: RefCell<Vec<Utxo>>,
1458 secp: Secp256k1<bitcoin::secp256k1::All>,
1461 impl TestWalletSource {
1462 pub fn new(secret_key: SecretKey) -> Self {
1465 utxos: RefCell::new(Vec::new()),
1466 secp: Secp256k1::new(),
1470 pub fn add_utxo(&self, outpoint: bitcoin::OutPoint, value: u64) -> TxOut {
1471 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1472 let utxo = Utxo::new_p2pkh(outpoint, value, &public_key.pubkey_hash());
1473 self.utxos.borrow_mut().push(utxo.clone());
1477 pub fn add_custom_utxo(&self, utxo: Utxo) -> TxOut {
1478 let output = utxo.output.clone();
1479 self.utxos.borrow_mut().push(utxo);
1483 pub fn remove_utxo(&self, outpoint: bitcoin::OutPoint) {
1484 self.utxos.borrow_mut().retain(|utxo| utxo.outpoint != outpoint);
1488 impl WalletSource for TestWalletSource {
1489 fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()> {
1490 Ok(self.utxos.borrow().clone())
1493 fn get_change_script(&self) -> Result<ScriptBuf, ()> {
1494 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1495 Ok(ScriptBuf::new_p2pkh(&public_key.pubkey_hash()))
1498 fn sign_psbt(&self, psbt: PartiallySignedTransaction) -> Result<Transaction, ()> {
1499 let mut tx = psbt.extract_tx();
1500 let utxos = self.utxos.borrow();
1501 for i in 0..tx.input.len() {
1502 if let Some(utxo) = utxos.iter().find(|utxo| utxo.outpoint == tx.input[i].previous_output) {
1503 let sighash = SighashCache::new(&tx)
1504 .legacy_signature_hash(i, &utxo.output.script_pubkey, EcdsaSighashType::All as u32)
1506 let sig = self.secp.sign_ecdsa(&(*sighash.as_raw_hash()).into(), &self.secret_key);
1507 let bitcoin_sig = bitcoin::ecdsa::Signature { sig, hash_ty: EcdsaSighashType::All };
1508 tx.input[i].script_sig = Builder::new()
1509 .push_slice(&bitcoin_sig.serialize())
1510 .push_slice(&self.secret_key.public_key(&self.secp).serialize())