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::message::ForwardNode;
12 use crate::blinded_path::payment::ReceiveTlvs;
14 use crate::chain::WatchedOutput;
15 use crate::chain::chaininterface;
16 use crate::chain::chaininterface::ConfirmationTarget;
18 use crate::chain::chaininterface::FEERATE_FLOOR_SATS_PER_KW;
19 use crate::chain::chainmonitor;
20 use crate::chain::channelmonitor;
21 use crate::chain::channelmonitor::MonitorEvent;
22 use crate::chain::transaction::OutPoint;
23 use crate::routing::router::{CandidateRouteHop, FirstHopCandidate, PublicHopCandidate, PrivateHopCandidate};
26 use crate::events::bump_transaction::{WalletSource, Utxo};
27 use crate::ln::types::ChannelId;
28 use crate::ln::channel_state::ChannelDetails;
29 use crate::ln::channelmanager;
31 use crate::ln::chan_utils::CommitmentTransaction;
32 use crate::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
33 use crate::ln::{msgs, wire};
34 use crate::ln::msgs::LightningError;
35 use crate::ln::script::ShutdownScript;
36 use crate::offers::invoice::{BlindedPayInfo, UnsignedBolt12Invoice};
37 use crate::offers::invoice_request::UnsignedInvoiceRequest;
38 use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageRouter, OnionMessagePath};
39 use crate::routing::gossip::{EffectiveCapacity, NetworkGraph, NodeId, RoutingFees};
40 use crate::routing::utxo::{UtxoLookup, UtxoLookupError, UtxoResult};
41 use crate::routing::router::{DefaultRouter, InFlightHtlcs, Path, Route, RouteParameters, RouteHintHop, Router, ScorerAccountingForInFlightHtlcs};
42 use crate::routing::scoring::{ChannelUsage, ScoreUpdate, ScoreLookUp};
43 use crate::sync::RwLock;
44 use crate::util::config::UserConfig;
45 use crate::util::test_channel_signer::{TestChannelSigner, EnforcementState};
46 use crate::util::logger::{Logger, Level, Record};
47 use crate::util::ser::{Readable, ReadableArgs, Writer, Writeable};
48 use crate::util::persist::KVStore;
50 use bitcoin::amount::Amount;
51 use bitcoin::blockdata::constants::ChainHash;
52 use bitcoin::blockdata::constants::genesis_block;
53 use bitcoin::blockdata::transaction::{Transaction, TxOut};
54 use bitcoin::blockdata::script::{Builder, Script, ScriptBuf};
55 use bitcoin::blockdata::opcodes;
56 use bitcoin::blockdata::block::Block;
57 use bitcoin::network::Network;
58 use bitcoin::hash_types::{BlockHash, Txid};
59 use bitcoin::hashes::Hash;
60 use bitcoin::sighash::{SighashCache, EcdsaSighashType};
62 use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, self};
63 use bitcoin::secp256k1::ecdh::SharedSecret;
64 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
65 use bitcoin::secp256k1::schnorr;
68 use crate::prelude::*;
69 use core::cell::RefCell;
70 use core::time::Duration;
71 use crate::sync::{Mutex, Arc};
72 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
75 use crate::sign::{InMemorySigner, RandomBytes, Recipient, EntropySource, NodeSigner, SignerProvider};
77 #[cfg(feature = "std")]
78 use std::time::{SystemTime, UNIX_EPOCH};
79 use bitcoin::psbt::Psbt;
80 use bitcoin::Sequence;
82 use super::test_channel_signer::SignerOp;
84 pub fn pubkey(byte: u8) -> PublicKey {
85 let secp_ctx = Secp256k1::new();
86 PublicKey::from_secret_key(&secp_ctx, &privkey(byte))
89 pub fn privkey(byte: u8) -> SecretKey {
90 SecretKey::from_slice(&[byte; 32]).unwrap()
93 pub struct TestVecWriter(pub Vec<u8>);
94 impl Writer for TestVecWriter {
95 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
96 self.0.extend_from_slice(buf);
101 pub struct TestFeeEstimator {
102 pub sat_per_kw: Mutex<u32>,
104 impl chaininterface::FeeEstimator for TestFeeEstimator {
105 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
106 *self.sat_per_kw.lock().unwrap()
110 pub struct TestRouter<'a> {
111 pub router: DefaultRouter<
112 Arc<NetworkGraph<&'a TestLogger>>,
115 &'a RwLock<TestScorer>,
119 //pub entropy_source: &'a RandomBytes,
120 pub network_graph: Arc<NetworkGraph<&'a TestLogger>>,
121 pub next_routes: Mutex<VecDeque<(RouteParameters, Option<Result<Route, LightningError>>)>>,
122 pub scorer: &'a RwLock<TestScorer>,
125 impl<'a> TestRouter<'a> {
127 network_graph: Arc<NetworkGraph<&'a TestLogger>>, logger: &'a TestLogger,
128 scorer: &'a RwLock<TestScorer>,
130 let entropy_source = Arc::new(RandomBytes::new([42; 32]));
132 router: DefaultRouter::new(network_graph.clone(), logger, entropy_source, scorer, ()),
134 next_routes: Mutex::new(VecDeque::new()),
139 pub fn expect_find_route(&self, query: RouteParameters, result: Result<Route, LightningError>) {
140 let mut expected_routes = self.next_routes.lock().unwrap();
141 expected_routes.push_back((query, Some(result)));
144 pub fn expect_find_route_query(&self, query: RouteParameters) {
145 let mut expected_routes = self.next_routes.lock().unwrap();
146 expected_routes.push_back((query, None));
150 impl<'a> Router for TestRouter<'a> {
152 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
153 inflight_htlcs: InFlightHtlcs
154 ) -> Result<Route, msgs::LightningError> {
156 let next_route_opt = self.next_routes.lock().unwrap().pop_front();
157 if let Some((find_route_query, find_route_res)) = next_route_opt {
158 assert_eq!(find_route_query, *params);
159 if let Some(res) = find_route_res {
160 if let Ok(ref route) = res {
161 assert_eq!(route.route_params, Some(find_route_query));
162 let scorer = self.scorer.read().unwrap();
163 let scorer = ScorerAccountingForInFlightHtlcs::new(scorer, &inflight_htlcs);
164 for path in &route.paths {
165 let mut aggregate_msat = 0u64;
166 let mut prev_hop_node = payer;
167 for (idx, hop) in path.hops.iter().rev().enumerate() {
168 aggregate_msat += hop.fee_msat;
169 let usage = ChannelUsage {
170 amount_msat: aggregate_msat,
171 inflight_htlc_msat: 0,
172 effective_capacity: EffectiveCapacity::Unknown,
175 if idx == path.hops.len() - 1 {
176 if let Some(first_hops) = first_hops {
177 if let Some(idx) = first_hops.iter().position(|h| h.get_outbound_payment_scid() == Some(hop.short_channel_id)) {
178 let node_id = NodeId::from_pubkey(payer);
179 let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
180 details: first_hops[idx],
181 payer_node_id: &node_id,
183 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
188 let network_graph = self.network_graph.read_only();
189 if let Some(channel) = network_graph.channel(hop.short_channel_id) {
190 let (directed, _) = channel.as_directed_to(&NodeId::from_pubkey(&hop.pubkey)).unwrap();
191 let candidate = CandidateRouteHop::PublicHop(PublicHopCandidate {
193 short_channel_id: hop.short_channel_id,
195 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
197 let target_node_id = NodeId::from_pubkey(&hop.pubkey);
198 let route_hint = RouteHintHop {
199 src_node_id: *prev_hop_node,
200 short_channel_id: hop.short_channel_id,
201 fees: RoutingFees { base_msat: 0, proportional_millionths: 0 },
202 cltv_expiry_delta: 0,
203 htlc_minimum_msat: None,
204 htlc_maximum_msat: None,
206 let candidate = CandidateRouteHop::PrivateHop(PrivateHopCandidate {
208 target_node_id: &target_node_id,
210 scorer.channel_penalty_msat(&candidate, usage, &Default::default());
212 prev_hop_node = &hop.pubkey;
218 route_res = self.router.find_route(payer, params, first_hops, inflight_htlcs);
221 route_res = self.router.find_route(payer, params, first_hops, inflight_htlcs);
224 if let Ok(route) = &route_res {
225 // Previously, `Route`s failed to round-trip through serialization due to a write/read
226 // mismatch. Thus, here we test all test-generated routes round-trip:
227 let ser = route.encode();
228 assert_eq!(Route::read(&mut &ser[..]).unwrap(), *route);
233 fn create_blinded_payment_paths<
234 T: secp256k1::Signing + secp256k1::Verification
236 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
237 amount_msats: u64, secp_ctx: &Secp256k1<T>,
238 ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
239 self.router.create_blinded_payment_paths(
240 recipient, first_hops, tlvs, amount_msats, secp_ctx
245 impl<'a> MessageRouter for TestRouter<'a> {
247 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
248 ) -> Result<OnionMessagePath, ()> {
249 self.router.find_path(sender, peers, destination)
252 fn create_blinded_paths<
253 T: secp256k1::Signing + secp256k1::Verification
255 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
256 ) -> Result<Vec<BlindedPath>, ()> {
257 self.router.create_blinded_paths(recipient, peers, secp_ctx)
260 fn create_compact_blinded_paths<
261 T: secp256k1::Signing + secp256k1::Verification
263 &self, recipient: PublicKey, peers: Vec<ForwardNode>, secp_ctx: &Secp256k1<T>,
264 ) -> Result<Vec<BlindedPath>, ()> {
265 self.router.create_compact_blinded_paths(recipient, peers, secp_ctx)
269 impl<'a> Drop for TestRouter<'a> {
271 #[cfg(feature = "std")] {
272 if std::thread::panicking() {
276 assert!(self.next_routes.lock().unwrap().is_empty());
280 pub struct TestMessageRouter<'a> {
281 inner: DefaultMessageRouter<Arc<NetworkGraph<&'a TestLogger>>, &'a TestLogger, &'a TestKeysInterface>,
284 impl<'a> TestMessageRouter<'a> {
285 pub fn new(network_graph: Arc<NetworkGraph<&'a TestLogger>>, entropy_source: &'a TestKeysInterface) -> Self {
286 Self { inner: DefaultMessageRouter::new(network_graph, entropy_source) }
290 impl<'a> MessageRouter for TestMessageRouter<'a> {
292 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
293 ) -> Result<OnionMessagePath, ()> {
294 self.inner.find_path(sender, peers, destination)
297 fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
298 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
299 ) -> Result<Vec<BlindedPath>, ()> {
300 self.inner.create_blinded_paths(recipient, peers, secp_ctx)
303 fn create_compact_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
304 &self, recipient: PublicKey, peers: Vec<ForwardNode>, secp_ctx: &Secp256k1<T>,
305 ) -> Result<Vec<BlindedPath>, ()> {
306 self.inner.create_compact_blinded_paths(recipient, peers, secp_ctx)
310 pub struct OnlyReadsKeysInterface {}
312 impl EntropySource for OnlyReadsKeysInterface {
313 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
315 impl SignerProvider for OnlyReadsKeysInterface {
316 type EcdsaSigner = TestChannelSigner;
318 type TaprootSigner = TestChannelSigner;
320 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
322 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner { unreachable!(); }
324 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
325 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
326 let state = Arc::new(Mutex::new(EnforcementState::new()));
328 Ok(TestChannelSigner::new_with_revoked(
335 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { Err(()) }
336 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { Err(()) }
339 pub struct TestChainMonitor<'a> {
340 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<TestChannelSigner>)>>,
341 pub monitor_updates: Mutex<HashMap<ChannelId, Vec<channelmonitor::ChannelMonitorUpdate>>>,
342 pub latest_monitor_update_id: Mutex<HashMap<ChannelId, (OutPoint, u64, u64)>>,
343 pub chain_monitor: chainmonitor::ChainMonitor<TestChannelSigner, &'a TestChainSource, &'a dyn chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a dyn chainmonitor::Persist<TestChannelSigner>>,
344 pub keys_manager: &'a TestKeysInterface,
345 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
346 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
348 pub expect_channel_force_closed: Mutex<Option<(ChannelId, bool)>>,
349 /// If this is set to Some(), the next round trip serialization check will not hold after an
350 /// update_channel call (not watch_channel) for the given channel_id.
351 pub expect_monitor_round_trip_fail: Mutex<Option<ChannelId>>,
353 impl<'a> TestChainMonitor<'a> {
354 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 {
356 added_monitors: Mutex::new(Vec::new()),
357 monitor_updates: Mutex::new(new_hash_map()),
358 latest_monitor_update_id: Mutex::new(new_hash_map()),
359 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
361 expect_channel_force_closed: Mutex::new(None),
362 expect_monitor_round_trip_fail: Mutex::new(None),
366 pub fn complete_sole_pending_chan_update(&self, channel_id: &ChannelId) {
367 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
368 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
371 impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {
372 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
373 // At every point where we get a monitor update, we should be able to send a useful monitor
374 // to a watchtower and disk...
375 let mut w = TestVecWriter(Vec::new());
376 monitor.write(&mut w).unwrap();
377 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
378 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
379 assert!(new_monitor == monitor);
380 self.latest_monitor_update_id.lock().unwrap().insert(monitor.channel_id(),
381 (funding_txo, monitor.get_latest_update_id(), monitor.get_latest_update_id()));
382 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
383 self.chain_monitor.watch_channel(funding_txo, new_monitor)
386 fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
387 // Every monitor update should survive roundtrip
388 let mut w = TestVecWriter(Vec::new());
389 update.write(&mut w).unwrap();
390 assert!(channelmonitor::ChannelMonitorUpdate::read(
391 &mut io::Cursor::new(&w.0)).unwrap() == *update);
392 let channel_id = update.channel_id.unwrap_or(ChannelId::v1_from_funding_outpoint(funding_txo));
394 self.monitor_updates.lock().unwrap().entry(channel_id).or_insert(Vec::new()).push(update.clone());
396 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
397 assert_eq!(channel_id, exp.0);
398 assert_eq!(update.updates.len(), 1);
399 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
400 assert_eq!(should_broadcast, exp.1);
404 self.latest_monitor_update_id.lock().unwrap().insert(channel_id,
405 (funding_txo, update.update_id, update.update_id));
406 let update_res = self.chain_monitor.update_channel(funding_txo, update);
407 // At every point where we get a monitor update, we should be able to send a useful monitor
408 // to a watchtower and disk...
409 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
411 monitor.write(&mut w).unwrap();
412 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
413 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
414 if let Some(chan_id) = self.expect_monitor_round_trip_fail.lock().unwrap().take() {
415 assert_eq!(chan_id, channel_id);
416 assert!(new_monitor != *monitor);
418 assert!(new_monitor == *monitor);
420 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
424 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, Option<PublicKey>)> {
425 return self.chain_monitor.release_pending_monitor_events();
430 struct JusticeTxData {
431 justice_tx: Transaction,
433 commitment_number: u64,
437 pub(crate) struct WatchtowerPersister {
438 persister: TestPersister,
439 /// Upon a new commitment_signed, we'll get a
440 /// ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTxInfo. We'll store the justice tx
441 /// amount, and commitment number so we can build the justice tx after our counterparty
443 unsigned_justice_tx_data: Mutex<HashMap<OutPoint, VecDeque<JusticeTxData>>>,
444 /// After receiving a revoke_and_ack for a commitment number, we'll form and store the justice
445 /// tx which would be used to provide a watchtower with the data it needs.
446 watchtower_state: Mutex<HashMap<OutPoint, HashMap<Txid, Transaction>>>,
447 destination_script: ScriptBuf,
451 impl WatchtowerPersister {
453 pub(crate) fn new(destination_script: ScriptBuf) -> Self {
454 WatchtowerPersister {
455 persister: TestPersister::new(),
456 unsigned_justice_tx_data: Mutex::new(new_hash_map()),
457 watchtower_state: Mutex::new(new_hash_map()),
463 pub(crate) fn justice_tx(&self, funding_txo: OutPoint, commitment_txid: &Txid)
464 -> Option<Transaction> {
465 self.watchtower_state.lock().unwrap().get(&funding_txo).unwrap().get(commitment_txid).cloned()
468 fn form_justice_data_from_commitment(&self, counterparty_commitment_tx: &CommitmentTransaction)
469 -> Option<JusticeTxData> {
470 let trusted_tx = counterparty_commitment_tx.trust();
471 let output_idx = trusted_tx.revokeable_output_index()?;
472 let built_tx = trusted_tx.built_transaction();
473 let value = built_tx.transaction.output[output_idx as usize].value;
474 let justice_tx = trusted_tx.build_to_local_justice_tx(
475 FEERATE_FLOOR_SATS_PER_KW as u64, self.destination_script.clone()).ok()?;
476 let commitment_number = counterparty_commitment_tx.commitment_number();
477 Some(JusticeTxData { justice_tx, value, commitment_number })
482 impl<Signer: sign::ecdsa::EcdsaChannelSigner> chainmonitor::Persist<Signer> for WatchtowerPersister {
483 fn persist_new_channel(&self, funding_txo: OutPoint,
484 data: &channelmonitor::ChannelMonitor<Signer>
485 ) -> chain::ChannelMonitorUpdateStatus {
486 let res = self.persister.persist_new_channel(funding_txo, data);
488 assert!(self.unsigned_justice_tx_data.lock().unwrap()
489 .insert(funding_txo, VecDeque::new()).is_none());
490 assert!(self.watchtower_state.lock().unwrap()
491 .insert(funding_txo, new_hash_map()).is_none());
493 let initial_counterparty_commitment_tx = data.initial_counterparty_commitment_tx()
494 .expect("First and only call expects Some");
495 if let Some(justice_data)
496 = self.form_justice_data_from_commitment(&initial_counterparty_commitment_tx) {
497 self.unsigned_justice_tx_data.lock().unwrap()
498 .get_mut(&funding_txo).unwrap()
499 .push_back(justice_data);
504 fn update_persisted_channel(
505 &self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>,
506 data: &channelmonitor::ChannelMonitor<Signer>
507 ) -> chain::ChannelMonitorUpdateStatus {
508 let res = self.persister.update_persisted_channel(funding_txo, update, data);
510 if let Some(update) = update {
511 let commitment_txs = data.counterparty_commitment_txs_from_update(update);
512 let justice_datas = commitment_txs.into_iter()
513 .filter_map(|commitment_tx| self.form_justice_data_from_commitment(&commitment_tx));
514 let mut channels_justice_txs = self.unsigned_justice_tx_data.lock().unwrap();
515 let channel_state = channels_justice_txs.get_mut(&funding_txo).unwrap();
516 channel_state.extend(justice_datas);
518 while let Some(JusticeTxData { justice_tx, value, commitment_number }) = channel_state.front() {
520 let commitment_txid = justice_tx.input[input_idx].previous_output.txid;
521 match data.sign_to_local_justice_tx(justice_tx.clone(), input_idx, value.to_sat(), *commitment_number) {
522 Ok(signed_justice_tx) => {
523 let dup = self.watchtower_state.lock().unwrap()
524 .get_mut(&funding_txo).unwrap()
525 .insert(commitment_txid, signed_justice_tx);
526 assert!(dup.is_none());
527 channel_state.pop_front();
536 fn archive_persisted_channel(&self, funding_txo: OutPoint) {
537 <TestPersister as chainmonitor::Persist<TestChannelSigner>>::archive_persisted_channel(&self.persister, funding_txo);
541 pub struct TestPersister {
542 /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
544 pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
545 /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
546 /// [`ChannelMonitor::get_latest_update_id`] here.
548 /// [`ChannelMonitor`]: channelmonitor::ChannelMonitor
549 pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<u64>>>,
550 /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
551 /// monitor's funding outpoint here.
552 pub chain_sync_monitor_persistences: Mutex<VecDeque<OutPoint>>
555 pub fn new() -> Self {
557 update_rets: Mutex::new(VecDeque::new()),
558 offchain_monitor_updates: Mutex::new(new_hash_map()),
559 chain_sync_monitor_persistences: Mutex::new(VecDeque::new())
563 /// Queue an update status to return.
564 pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
565 self.update_rets.lock().unwrap().push_back(next_ret);
568 impl<Signer: sign::ecdsa::EcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
569 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>) -> chain::ChannelMonitorUpdateStatus {
570 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
573 chain::ChannelMonitorUpdateStatus::Completed
576 fn update_persisted_channel(&self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>) -> chain::ChannelMonitorUpdateStatus {
577 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
578 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
582 if let Some(update) = update {
583 self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(new_hash_set()).insert(update.update_id);
585 self.chain_sync_monitor_persistences.lock().unwrap().push_back(funding_txo);
590 fn archive_persisted_channel(&self, funding_txo: OutPoint) {
591 // remove the channel from the offchain_monitor_updates and chain_sync_monitor_persistences.
592 self.offchain_monitor_updates.lock().unwrap().remove(&funding_txo);
593 self.chain_sync_monitor_persistences.lock().unwrap().retain(|x| x != &funding_txo);
597 pub struct TestStore {
598 persisted_bytes: Mutex<HashMap<String, HashMap<String, Vec<u8>>>>,
603 pub fn new(read_only: bool) -> Self {
604 let persisted_bytes = Mutex::new(new_hash_map());
605 Self { persisted_bytes, read_only }
609 impl KVStore for TestStore {
610 fn read(&self, primary_namespace: &str, secondary_namespace: &str, key: &str) -> io::Result<Vec<u8>> {
611 let persisted_lock = self.persisted_bytes.lock().unwrap();
612 let prefixed = if secondary_namespace.is_empty() {
613 primary_namespace.to_string()
615 format!("{}/{}", primary_namespace, secondary_namespace)
618 if let Some(outer_ref) = persisted_lock.get(&prefixed) {
619 if let Some(inner_ref) = outer_ref.get(key) {
620 let bytes = inner_ref.clone();
623 Err(io::Error::new(io::ErrorKind::NotFound, "Key not found"))
626 Err(io::Error::new(io::ErrorKind::NotFound, "Namespace not found"))
630 fn write(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: &[u8]) -> io::Result<()> {
632 return Err(io::Error::new(
633 io::ErrorKind::PermissionDenied,
634 "Cannot modify read-only store",
637 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
639 let prefixed = if secondary_namespace.is_empty() {
640 primary_namespace.to_string()
642 format!("{}/{}", primary_namespace, secondary_namespace)
644 let outer_e = persisted_lock.entry(prefixed).or_insert(new_hash_map());
645 let mut bytes = Vec::new();
646 bytes.write_all(buf)?;
647 outer_e.insert(key.to_string(), bytes);
651 fn remove(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, _lazy: bool) -> io::Result<()> {
653 return Err(io::Error::new(
654 io::ErrorKind::PermissionDenied,
655 "Cannot modify read-only store",
659 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
661 let prefixed = if secondary_namespace.is_empty() {
662 primary_namespace.to_string()
664 format!("{}/{}", primary_namespace, secondary_namespace)
666 if let Some(outer_ref) = persisted_lock.get_mut(&prefixed) {
667 outer_ref.remove(&key.to_string());
673 fn list(&self, primary_namespace: &str, secondary_namespace: &str) -> io::Result<Vec<String>> {
674 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
676 let prefixed = if secondary_namespace.is_empty() {
677 primary_namespace.to_string()
679 format!("{}/{}", primary_namespace, secondary_namespace)
681 match persisted_lock.entry(prefixed) {
682 hash_map::Entry::Occupied(e) => Ok(e.get().keys().cloned().collect()),
683 hash_map::Entry::Vacant(_) => Ok(Vec::new()),
688 unsafe impl Sync for TestStore {}
689 unsafe impl Send for TestStore {}
691 pub struct TestBroadcaster {
692 pub txn_broadcasted: Mutex<Vec<Transaction>>,
693 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
696 impl TestBroadcaster {
697 pub fn new(network: Network) -> Self {
699 txn_broadcasted: Mutex::new(Vec::new()),
700 blocks: Arc::new(Mutex::new(vec![(genesis_block(network), 0)])),
704 pub fn with_blocks(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> Self {
705 Self { txn_broadcasted: Mutex::new(Vec::new()), blocks }
708 pub fn txn_broadcast(&self) -> Vec<Transaction> {
709 self.txn_broadcasted.lock().unwrap().split_off(0)
712 pub fn unique_txn_broadcast(&self) -> Vec<Transaction> {
713 let mut txn = self.txn_broadcasted.lock().unwrap().split_off(0);
714 let mut seen = new_hash_set();
715 txn.retain(|tx| seen.insert(tx.txid()));
720 impl chaininterface::BroadcasterInterface for TestBroadcaster {
721 fn broadcast_transactions(&self, txs: &[&Transaction]) {
723 let lock_time = tx.lock_time.to_consensus_u32();
724 assert!(lock_time < 1_500_000_000);
725 if tx.lock_time.is_block_height() && lock_time > self.blocks.lock().unwrap().last().unwrap().1 {
726 for inp in tx.input.iter() {
727 if inp.sequence != Sequence::MAX {
728 panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
733 let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
734 self.txn_broadcasted.lock().unwrap().extend(owned_txs);
738 pub struct TestChannelMessageHandler {
739 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
740 expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
741 connected_peers: Mutex<HashSet<PublicKey>>,
742 pub message_fetch_counter: AtomicUsize,
743 chain_hash: ChainHash,
746 impl TestChannelMessageHandler {
747 pub fn new(chain_hash: ChainHash) -> Self {
748 TestChannelMessageHandler {
749 pending_events: Mutex::new(Vec::new()),
750 expected_recv_msgs: Mutex::new(None),
751 connected_peers: Mutex::new(new_hash_set()),
752 message_fetch_counter: AtomicUsize::new(0),
758 pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
759 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
760 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
761 expected_msgs.as_mut().unwrap().push(ev);
764 fn received_msg(&self, _ev: wire::Message<()>) {
765 let mut msgs = self.expected_recv_msgs.lock().unwrap();
766 if msgs.is_none() { return; }
767 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
769 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
770 msgs.as_mut().unwrap().remove(0);
774 impl Drop for TestChannelMessageHandler {
776 #[cfg(feature = "std")]
778 let l = self.expected_recv_msgs.lock().unwrap();
779 if !std::thread::panicking() {
780 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
786 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
787 fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
788 self.received_msg(wire::Message::OpenChannel(msg.clone()));
790 fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
791 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
793 fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
794 self.received_msg(wire::Message::FundingCreated(msg.clone()));
796 fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
797 self.received_msg(wire::Message::FundingSigned(msg.clone()));
799 fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
800 self.received_msg(wire::Message::ChannelReady(msg.clone()));
802 fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
803 self.received_msg(wire::Message::Shutdown(msg.clone()));
805 fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
806 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
808 fn handle_stfu(&self, _their_node_id: &PublicKey, msg: &msgs::Stfu) {
809 self.received_msg(wire::Message::Stfu(msg.clone()));
812 fn handle_splice_init(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceInit) {
813 self.received_msg(wire::Message::SpliceInit(msg.clone()));
816 fn handle_splice_ack(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
817 self.received_msg(wire::Message::SpliceAck(msg.clone()));
820 fn handle_splice_locked(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
821 self.received_msg(wire::Message::SpliceLocked(msg.clone()));
823 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
824 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
826 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
827 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
829 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
830 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
832 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
833 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
835 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
836 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
838 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
839 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
841 fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
842 self.received_msg(wire::Message::UpdateFee(msg.clone()));
844 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
845 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
847 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
848 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
850 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
851 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
853 fn peer_disconnected(&self, their_node_id: &PublicKey) {
854 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
856 fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
857 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
858 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
859 // bother re-generating the expected Init message in all tests.
862 fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
863 self.received_msg(wire::Message::Error(msg.clone()));
865 fn provided_node_features(&self) -> NodeFeatures {
866 channelmanager::provided_node_features(&UserConfig::default())
868 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
869 channelmanager::provided_init_features(&UserConfig::default())
872 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
873 Some(vec![self.chain_hash])
876 fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
877 self.received_msg(wire::Message::OpenChannelV2(msg.clone()));
880 fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
881 self.received_msg(wire::Message::AcceptChannelV2(msg.clone()));
884 fn handle_tx_add_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
885 self.received_msg(wire::Message::TxAddInput(msg.clone()));
888 fn handle_tx_add_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
889 self.received_msg(wire::Message::TxAddOutput(msg.clone()));
892 fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
893 self.received_msg(wire::Message::TxRemoveInput(msg.clone()));
896 fn handle_tx_remove_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
897 self.received_msg(wire::Message::TxRemoveOutput(msg.clone()));
900 fn handle_tx_complete(&self, _their_node_id: &PublicKey, msg: &msgs::TxComplete) {
901 self.received_msg(wire::Message::TxComplete(msg.clone()));
904 fn handle_tx_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
905 self.received_msg(wire::Message::TxSignatures(msg.clone()));
908 fn handle_tx_init_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
909 self.received_msg(wire::Message::TxInitRbf(msg.clone()));
912 fn handle_tx_ack_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
913 self.received_msg(wire::Message::TxAckRbf(msg.clone()));
916 fn handle_tx_abort(&self, _their_node_id: &PublicKey, msg: &msgs::TxAbort) {
917 self.received_msg(wire::Message::TxAbort(msg.clone()));
921 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
922 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
923 self.message_fetch_counter.fetch_add(1, Ordering::AcqRel);
924 let mut pending_events = self.pending_events.lock().unwrap();
925 let mut ret = Vec::new();
926 mem::swap(&mut ret, &mut *pending_events);
931 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
932 use bitcoin::secp256k1::ffi::Signature as FFISignature;
933 let secp_ctx = Secp256k1::new();
934 let network = Network::Testnet;
935 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
936 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
937 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
938 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
939 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
940 features: ChannelFeatures::empty(),
941 chain_hash: ChainHash::using_genesis_block(network),
942 short_channel_id: short_chan_id,
943 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
944 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
945 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
946 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
947 excess_data: Vec::new(),
951 msgs::ChannelAnnouncement {
952 node_signature_1: Signature::from(FFISignature::new()),
953 node_signature_2: Signature::from(FFISignature::new()),
954 bitcoin_signature_1: Signature::from(FFISignature::new()),
955 bitcoin_signature_2: Signature::from(FFISignature::new()),
956 contents: unsigned_ann,
961 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
962 use bitcoin::secp256k1::ffi::Signature as FFISignature;
963 let network = Network::Testnet;
964 msgs::ChannelUpdate {
965 signature: Signature::from(unsafe { FFISignature::new() }),
966 contents: msgs::UnsignedChannelUpdate {
967 chain_hash: ChainHash::using_genesis_block(network),
968 short_channel_id: short_chan_id,
971 cltv_expiry_delta: 0,
972 htlc_minimum_msat: 0,
973 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
975 fee_proportional_millionths: 0,
981 pub struct TestRoutingMessageHandler {
982 pub chan_upds_recvd: AtomicUsize,
983 pub chan_anns_recvd: AtomicUsize,
984 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
985 pub request_full_sync: AtomicBool,
988 impl TestRoutingMessageHandler {
989 pub fn new() -> Self {
990 TestRoutingMessageHandler {
991 chan_upds_recvd: AtomicUsize::new(0),
992 chan_anns_recvd: AtomicUsize::new(0),
993 pending_events: Mutex::new(vec![]),
994 request_full_sync: AtomicBool::new(false),
998 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
999 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
1000 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
1002 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
1003 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
1004 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
1006 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
1007 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
1008 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
1010 fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
1011 let chan_upd_1 = get_dummy_channel_update(starting_point);
1012 let chan_upd_2 = get_dummy_channel_update(starting_point);
1013 let chan_ann = get_dummy_channel_announcement(starting_point);
1015 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
1018 fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
1022 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
1023 if !init_msg.features.supports_gossip_queries() {
1027 #[allow(unused_mut, unused_assignments)]
1028 let mut gossip_start_time = 0;
1029 #[cfg(feature = "std")]
1031 gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
1032 if self.request_full_sync.load(Ordering::Acquire) {
1033 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
1035 gossip_start_time -= 60 * 60; // an hour ago
1039 let mut pending_events = self.pending_events.lock().unwrap();
1040 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
1041 node_id: their_node_id.clone(),
1042 msg: msgs::GossipTimestampFilter {
1043 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
1044 first_timestamp: gossip_start_time as u32,
1045 timestamp_range: u32::max_value(),
1051 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
1055 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
1059 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
1063 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
1067 fn provided_node_features(&self) -> NodeFeatures {
1068 let mut features = NodeFeatures::empty();
1069 features.set_gossip_queries_optional();
1073 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
1074 let mut features = InitFeatures::empty();
1075 features.set_gossip_queries_optional();
1079 fn processing_queue_high(&self) -> bool { false }
1082 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
1083 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
1084 let mut ret = Vec::new();
1085 let mut pending_events = self.pending_events.lock().unwrap();
1086 core::mem::swap(&mut ret, &mut pending_events);
1091 pub struct TestLogger {
1093 pub(crate) id: String,
1094 pub lines: Mutex<HashMap<(&'static str, String), usize>>,
1095 pub context: Mutex<HashMap<(&'static str, Option<PublicKey>, Option<ChannelId>), usize>>,
1099 pub fn new() -> TestLogger {
1100 Self::with_id("".to_owned())
1102 pub fn with_id(id: String) -> TestLogger {
1104 level: Level::Trace,
1106 lines: Mutex::new(new_hash_map()),
1107 context: Mutex::new(new_hash_map()),
1110 pub fn enable(&mut self, level: Level) {
1113 pub fn assert_log(&self, module: &str, line: String, count: usize) {
1114 let log_entries = self.lines.lock().unwrap();
1115 assert_eq!(log_entries.get(&(module, line)), Some(&count));
1118 /// Search for the number of occurrence of the logged lines which
1119 /// 1. belongs to the specified module and
1120 /// 2. contains `line` in it.
1121 /// And asserts if the number of occurrences is the same with the given `count`
1122 pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
1123 let log_entries = self.lines.lock().unwrap();
1124 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1125 *m == module && l.contains(line)
1126 }).map(|(_, c) | { c }).sum();
1127 assert_eq!(l, count)
1130 /// Search for the number of occurrences of logged lines which
1131 /// 1. belong to the specified module and
1132 /// 2. match the given regex pattern.
1133 /// Assert that the number of occurrences equals the given `count`
1134 #[cfg(any(test, feature = "_test_utils"))]
1135 pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
1136 let log_entries = self.lines.lock().unwrap();
1137 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1138 *m == module && pattern.is_match(&l)
1139 }).map(|(_, c) | { c }).sum();
1140 assert_eq!(l, count)
1143 pub fn assert_log_context_contains(
1144 &self, module: &str, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>, count: usize
1146 let context_entries = self.context.lock().unwrap();
1147 let l = context_entries.get(&(module, peer_id, channel_id)).unwrap();
1148 assert_eq!(*l, count)
1152 impl Logger for TestLogger {
1153 fn log(&self, record: Record) {
1154 *self.lines.lock().unwrap().entry((record.module_path, format!("{}", record.args))).or_insert(0) += 1;
1155 *self.context.lock().unwrap().entry((record.module_path, record.peer_id, record.channel_id)).or_insert(0) += 1;
1156 if record.level >= self.level {
1157 #[cfg(all(not(ldk_bench), feature = "std"))] {
1158 let pfx = format!("{} {} [{}:{}]", self.id, record.level.to_string(), record.module_path, record.line);
1159 println!("{:<55}{}", pfx, record.args);
1165 pub struct TestNodeSigner {
1166 node_secret: SecretKey,
1169 impl TestNodeSigner {
1170 pub fn new(node_secret: SecretKey) -> Self {
1171 Self { node_secret }
1175 impl NodeSigner for TestNodeSigner {
1176 fn get_inbound_payment_key_material(&self) -> crate::sign::KeyMaterial {
1180 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1181 let node_secret = match recipient {
1182 Recipient::Node => Ok(&self.node_secret),
1183 Recipient::PhantomNode => Err(())
1185 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
1188 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
1189 let mut node_secret = match recipient {
1190 Recipient::Node => Ok(self.node_secret.clone()),
1191 Recipient::PhantomNode => Err(())
1193 if let Some(tweak) = tweak {
1194 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1196 Ok(SharedSecret::new(other_key, &node_secret))
1199 fn sign_invoice(&self, _: &[u8], _: &[bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
1203 fn sign_bolt12_invoice_request(
1204 &self, _invoice_request: &UnsignedInvoiceRequest
1205 ) -> Result<schnorr::Signature, ()> {
1209 fn sign_bolt12_invoice(
1210 &self, _invoice: &UnsignedBolt12Invoice,
1211 ) -> Result<schnorr::Signature, ()> {
1215 fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1220 pub struct TestKeysInterface {
1221 pub backing: sign::PhantomKeysManager,
1222 pub override_random_bytes: Mutex<Option<[u8; 32]>>,
1223 pub disable_revocation_policy_check: bool,
1224 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
1225 expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
1226 pub unavailable_signers: Mutex<HashSet<[u8; 32]>>,
1227 pub unavailable_signers_ops: Mutex<HashMap<[u8; 32], HashSet<SignerOp>>>,
1230 impl EntropySource for TestKeysInterface {
1231 fn get_secure_random_bytes(&self) -> [u8; 32] {
1232 let override_random_bytes = self.override_random_bytes.lock().unwrap();
1233 if let Some(bytes) = &*override_random_bytes {
1236 self.backing.get_secure_random_bytes()
1240 impl NodeSigner for TestKeysInterface {
1241 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1242 self.backing.get_node_id(recipient)
1245 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1246 self.backing.ecdh(recipient, other_key, tweak)
1249 fn get_inbound_payment_key_material(&self) -> sign::KeyMaterial {
1250 self.backing.get_inbound_payment_key_material()
1253 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1254 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
1257 fn sign_bolt12_invoice_request(
1258 &self, invoice_request: &UnsignedInvoiceRequest
1259 ) -> Result<schnorr::Signature, ()> {
1260 self.backing.sign_bolt12_invoice_request(invoice_request)
1263 fn sign_bolt12_invoice(
1264 &self, invoice: &UnsignedBolt12Invoice,
1265 ) -> Result<schnorr::Signature, ()> {
1266 self.backing.sign_bolt12_invoice(invoice)
1269 fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1270 self.backing.sign_gossip_message(msg)
1274 impl SignerProvider for TestKeysInterface {
1275 type EcdsaSigner = TestChannelSigner;
1277 type TaprootSigner = TestChannelSigner;
1279 fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1280 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1283 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> TestChannelSigner {
1284 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
1285 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1286 let mut signer = TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check);
1287 if let Some(ops) = self.unavailable_signers_ops.lock().unwrap().get(&channel_keys_id) {
1289 signer.disable_op(op);
1295 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
1296 let mut reader = io::Cursor::new(buffer);
1298 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
1299 let state = self.make_enforcement_state_cell(inner.commitment_seed);
1301 Ok(TestChannelSigner::new_with_revoked(
1304 self.disable_revocation_policy_check
1308 fn get_destination_script(&self, channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { self.backing.get_destination_script(channel_keys_id) }
1310 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1311 match &mut *self.expectations.lock().unwrap() {
1312 None => self.backing.get_shutdown_scriptpubkey(),
1313 Some(expectations) => match expectations.pop_front() {
1314 None => panic!("Unexpected get_shutdown_scriptpubkey"),
1315 Some(expectation) => Ok(expectation.returns),
1321 impl TestKeysInterface {
1322 pub fn new(seed: &[u8; 32], network: Network) -> Self {
1323 let now = Duration::from_secs(genesis_block(network).header.time as u64);
1325 backing: sign::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
1326 override_random_bytes: Mutex::new(None),
1327 disable_revocation_policy_check: false,
1328 enforcement_states: Mutex::new(new_hash_map()),
1329 expectations: Mutex::new(None),
1330 unavailable_signers: Mutex::new(new_hash_set()),
1331 unavailable_signers_ops: Mutex::new(new_hash_map()),
1335 /// Sets an expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] is
1337 pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
1338 self.expectations.lock().unwrap()
1339 .get_or_insert_with(|| VecDeque::new())
1340 .push_back(expectation);
1344 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> TestChannelSigner {
1345 self.derive_channel_signer(channel_value_satoshis, *id)
1348 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
1349 let mut states = self.enforcement_states.lock().unwrap();
1350 if !states.contains_key(&commitment_seed) {
1351 let state = EnforcementState::new();
1352 states.insert(commitment_seed, Arc::new(Mutex::new(state)));
1354 let cell = states.get(&commitment_seed).unwrap();
1359 pub(crate) fn panicking() -> bool {
1360 #[cfg(feature = "std")]
1361 let panicking = ::std::thread::panicking();
1362 #[cfg(not(feature = "std"))]
1363 let panicking = false;
1367 impl Drop for TestKeysInterface {
1368 fn drop(&mut self) {
1373 if let Some(expectations) = &*self.expectations.lock().unwrap() {
1374 if !expectations.is_empty() {
1375 panic!("Unsatisfied expectations: {:?}", expectations);
1381 /// An expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] was called and
1382 /// returns a [`ShutdownScript`].
1383 pub struct OnGetShutdownScriptpubkey {
1384 /// A shutdown script used to close a channel.
1385 pub returns: ShutdownScript,
1388 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
1389 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
1390 f.debug_struct("OnGetShutdownScriptpubkey").finish()
1394 pub struct TestChainSource {
1395 pub chain_hash: ChainHash,
1396 pub utxo_ret: Mutex<UtxoResult>,
1397 pub get_utxo_call_count: AtomicUsize,
1398 pub watched_txn: Mutex<HashSet<(Txid, ScriptBuf)>>,
1399 pub watched_outputs: Mutex<HashSet<(OutPoint, ScriptBuf)>>,
1402 impl TestChainSource {
1403 pub fn new(network: Network) -> Self {
1404 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1406 chain_hash: ChainHash::using_genesis_block(network),
1407 utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: Amount::MAX, script_pubkey }))),
1408 get_utxo_call_count: AtomicUsize::new(0),
1409 watched_txn: Mutex::new(new_hash_set()),
1410 watched_outputs: Mutex::new(new_hash_set()),
1413 pub fn remove_watched_txn_and_outputs(&self, outpoint: OutPoint, script_pubkey: ScriptBuf) {
1414 self.watched_outputs.lock().unwrap().remove(&(outpoint, script_pubkey.clone()));
1415 self.watched_txn.lock().unwrap().remove(&(outpoint.txid, script_pubkey));
1419 impl UtxoLookup for TestChainSource {
1420 fn get_utxo(&self, chain_hash: &ChainHash, _short_channel_id: u64) -> UtxoResult {
1421 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
1422 if self.chain_hash != *chain_hash {
1423 return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
1426 self.utxo_ret.lock().unwrap().clone()
1430 impl chain::Filter for TestChainSource {
1431 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
1432 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.into()));
1435 fn register_output(&self, output: WatchedOutput) {
1436 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
1440 impl Drop for TestChainSource {
1441 fn drop(&mut self) {
1448 pub struct TestScorer {
1449 /// Stores a tuple of (scid, ChannelUsage)
1450 scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
1454 pub fn new() -> Self {
1456 scorer_expectations: RefCell::new(None),
1460 pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
1461 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
1466 impl crate::util::ser::Writeable for TestScorer {
1467 fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
1470 impl ScoreLookUp for TestScorer {
1471 type ScoreParams = ();
1472 fn channel_penalty_msat(
1473 &self, candidate: &CandidateRouteHop, usage: ChannelUsage, _score_params: &Self::ScoreParams
1475 let short_channel_id = match candidate.globally_unique_short_channel_id() {
1479 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
1480 match scorer_expectations.pop_front() {
1481 Some((scid, expectation)) => {
1482 assert_eq!(expectation, usage);
1483 assert_eq!(scid, short_channel_id);
1492 impl ScoreUpdate for TestScorer {
1493 fn payment_path_failed(&mut self, _actual_path: &Path, _actual_short_channel_id: u64, _duration_since_epoch: Duration) {}
1495 fn payment_path_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1497 fn probe_failed(&mut self, _actual_path: &Path, _: u64, _duration_since_epoch: Duration) {}
1499 fn probe_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1501 fn time_passed(&mut self, _duration_since_epoch: Duration) {}
1505 impl crate::routing::scoring::Score for TestScorer {}
1507 impl Drop for TestScorer {
1508 fn drop(&mut self) {
1509 #[cfg(feature = "std")] {
1510 if std::thread::panicking() {
1515 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
1516 if !scorer_expectations.is_empty() {
1517 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
1523 pub struct TestWalletSource {
1524 secret_key: SecretKey,
1525 utxos: RefCell<Vec<Utxo>>,
1526 secp: Secp256k1<bitcoin::secp256k1::All>,
1529 impl TestWalletSource {
1530 pub fn new(secret_key: SecretKey) -> Self {
1533 utxos: RefCell::new(Vec::new()),
1534 secp: Secp256k1::new(),
1538 pub fn add_utxo(&self, outpoint: bitcoin::OutPoint, value: Amount) -> TxOut {
1539 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1540 let utxo = Utxo::new_p2pkh(outpoint, value, &public_key.pubkey_hash());
1541 self.utxos.borrow_mut().push(utxo.clone());
1545 pub fn add_custom_utxo(&self, utxo: Utxo) -> TxOut {
1546 let output = utxo.output.clone();
1547 self.utxos.borrow_mut().push(utxo);
1551 pub fn remove_utxo(&self, outpoint: bitcoin::OutPoint) {
1552 self.utxos.borrow_mut().retain(|utxo| utxo.outpoint != outpoint);
1556 impl WalletSource for TestWalletSource {
1557 fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()> {
1558 Ok(self.utxos.borrow().clone())
1561 fn get_change_script(&self) -> Result<ScriptBuf, ()> {
1562 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1563 Ok(ScriptBuf::new_p2pkh(&public_key.pubkey_hash()))
1566 fn sign_psbt(&self, psbt: Psbt) -> Result<Transaction, ()> {
1567 let mut tx = psbt.extract_tx_unchecked_fee_rate();
1568 let utxos = self.utxos.borrow();
1569 for i in 0..tx.input.len() {
1570 if let Some(utxo) = utxos.iter().find(|utxo| utxo.outpoint == tx.input[i].previous_output) {
1571 let sighash = SighashCache::new(&tx)
1572 .legacy_signature_hash(i, &utxo.output.script_pubkey, EcdsaSighashType::All as u32)
1574 let sig = self.secp.sign_ecdsa(&secp256k1::Message::from_digest(sighash.to_byte_array()), &self.secret_key);
1575 let bitcoin_sig = bitcoin::ecdsa::Signature { sig, hash_ty: EcdsaSighashType::All };
1576 tx.input[i].script_sig = Builder::new()
1577 .push_slice(&bitcoin_sig.serialize())
1578 .push_slice(&self.secret_key.public_key(&self.secp).serialize())