_ Git - rust-lightning/blob - lightning/src/util/test_utils.rs

   1 use chain::chaininterface;
   2 use chain::chaininterface::ConfirmationTarget;
   3 use chain::transaction::OutPoint;
   4 use chain::keysinterface;
   5 use ln::channelmonitor;
   6 use ln::msgs;
   7 use ln::msgs::{Features, FeatureContextInit, LightningError};
   8 use ln::channelmonitor::HTLCUpdate;
   9 use util::enforcing_trait_impls::EnforcingChannelKeys;
  10 use util::events;
  11 use util::logger::{Logger, Level, Record};
  12 use util::ser::{ReadableArgs, Writer};
  13
  14 use bitcoin::blockdata::transaction::Transaction;
  15 use bitcoin::blockdata::script::Script;
  16 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  17 use bitcoin::network::constants::Network;
  18
  19 use secp256k1::{SecretKey, PublicKey};
  20
  21 use std::time::{SystemTime, UNIX_EPOCH};
  22 use std::sync::{Arc,Mutex};
  23 use std::{mem};
  24 use std::collections::HashMap;
  25
  26 pub struct TestVecWriter(pub Vec<u8>);
  27 impl Writer for TestVecWriter {
  28         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
  29                 self.0.extend_from_slice(buf);
  30                 Ok(())
  31         }
  32         fn size_hint(&mut self, size: usize) {
  33                 self.0.reserve_exact(size);
  34         }
  35 }
  36
  37 pub struct TestFeeEstimator {
  38         pub sat_per_kw: u64,
  39 }
  40 impl chaininterface::FeeEstimator for TestFeeEstimator {
  41         fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u64 {
  42                 self.sat_per_kw
  43         }
  44 }
  45
  46 pub struct TestChannelMonitor {
  47         pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor)>>,
  48         pub simple_monitor: Arc<channelmonitor::SimpleManyChannelMonitor<OutPoint>>,
  49         pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
  50 }
  51 impl TestChannelMonitor {
  52         pub fn new(chain_monitor: Arc<chaininterface::ChainWatchInterface>, broadcaster: Arc<chaininterface::BroadcasterInterface>, logger: Arc<Logger>, fee_estimator: Arc<chaininterface::FeeEstimator>) -> Self {
  53                 Self {
  54                         added_monitors: Mutex::new(Vec::new()),
  55                         simple_monitor: channelmonitor::SimpleManyChannelMonitor::new(chain_monitor, broadcaster, logger, fee_estimator),
  56                         update_ret: Mutex::new(Ok(())),
  57                 }
  58         }
  59 }
  60 impl channelmonitor::ManyChannelMonitor for TestChannelMonitor {
  61         fn add_update_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
  62                 // At every point where we get a monitor update, we should be able to send a useful monitor
  63                 // to a watchtower and disk...
  64                 let mut w = TestVecWriter(Vec::new());
  65                 monitor.write_for_disk(&mut w).unwrap();
  66                 assert!(<(Sha256dHash, channelmonitor::ChannelMonitor)>::read(
  67                                 &mut ::std::io::Cursor::new(&w.0), Arc::new(TestLogger::new())).unwrap().1 == monitor);
  68                 w.0.clear();
  69                 monitor.write_for_watchtower(&mut w).unwrap(); // This at least shouldn't crash...
  70                 self.added_monitors.lock().unwrap().push((funding_txo, monitor.clone()));
  71                 assert!(self.simple_monitor.add_update_monitor(funding_txo, monitor).is_ok());
  72                 self.update_ret.lock().unwrap().clone()
  73         }
  74
  75         fn fetch_pending_htlc_updated(&self) -> Vec<HTLCUpdate> {
  76                 return self.simple_monitor.fetch_pending_htlc_updated();
  77         }
  78 }
  79
  80 pub struct TestBroadcaster {
  81         pub txn_broadcasted: Mutex<Vec<Transaction>>,
  82 }
  83 impl chaininterface::BroadcasterInterface for TestBroadcaster {
  84         fn broadcast_transaction(&self, tx: &Transaction) {
  85                 self.txn_broadcasted.lock().unwrap().push(tx.clone());
  86         }
  87 }
  88
  89 pub struct TestChannelMessageHandler {
  90         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
  91 }
  92
  93 impl TestChannelMessageHandler {
  94         pub fn new() -> Self {
  95                 TestChannelMessageHandler {
  96                         pending_events: Mutex::new(Vec::new()),
  97                 }
  98         }
  99 }
 100
 101 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
 102         fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: Features<FeatureContextInit>, _msg: &msgs::OpenChannel) {}
 103         fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: Features<FeatureContextInit>, _msg: &msgs::AcceptChannel) {}
 104         fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
 105         fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
 106         fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
 107         fn handle_shutdown(&self, _their_node_id: &PublicKey, _msg: &msgs::Shutdown) {}
 108         fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
 109         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
 110         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
 111         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
 112         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
 113         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
 114         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
 115         fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
 116         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
 117         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
 118         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
 119         fn peer_connected(&self, _their_node_id: &PublicKey) {}
 120         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
 121 }
 122
 123 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
 124         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 125                 let mut pending_events = self.pending_events.lock().unwrap();
 126                 let mut ret = Vec::new();
 127                 mem::swap(&mut ret, &mut *pending_events);
 128                 ret
 129         }
 130 }
 131
 132 pub struct TestRoutingMessageHandler {}
 133
 134 impl TestRoutingMessageHandler {
 135         pub fn new() -> Self {
 136                 TestRoutingMessageHandler {}
 137         }
 138 }
 139 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
 140         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> {
 141                 Err(LightningError { err: "", action: msgs::ErrorAction::IgnoreError })
 142         }
 143         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> {
 144                 Err(LightningError { err: "", action: msgs::ErrorAction::IgnoreError })
 145         }
 146         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> {
 147                 Err(LightningError { err: "", action: msgs::ErrorAction::IgnoreError })
 148         }
 149         fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
 150         fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, msgs::ChannelUpdate,msgs::ChannelUpdate)> {
 151                 Vec::new()
 152         }
 153         fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
 154                 Vec::new()
 155         }
 156 }
 157
 158 pub struct TestLogger {
 159         level: Level,
 160         id: String,
 161         pub lines: Mutex<HashMap<(String, String), usize>>,
 162 }
 163
 164 impl TestLogger {
 165         pub fn new() -> TestLogger {
 166                 Self::with_id("".to_owned())
 167         }
 168         pub fn with_id(id: String) -> TestLogger {
 169                 TestLogger {
 170                         level: Level::Trace,
 171                         id,
 172                         lines: Mutex::new(HashMap::new())
 173                 }
 174         }
 175         pub fn enable(&mut self, level: Level) {
 176                 self.level = level;
 177         }
 178         pub fn assert_log(&self, module: String, line: String, count: usize) {
 179                 let log_entries = self.lines.lock().unwrap();
 180                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
 181         }
 182 }
 183
 184 impl Logger for TestLogger {
 185         fn log(&self, record: &Record) {
 186                 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 187                 if self.level >= record.level {
 188                         println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
 189                 }
 190         }
 191 }
 192
 193 pub struct TestKeysInterface {
 194         backing: keysinterface::KeysManager,
 195         pub override_session_priv: Mutex<Option<SecretKey>>,
 196         pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
 197 }
 198
 199 impl keysinterface::KeysInterface for TestKeysInterface {
 200         type ChanKeySigner = EnforcingChannelKeys;
 201
 202         fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
 203         fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
 204         fn get_shutdown_pubkey(&self) -> PublicKey { self.backing.get_shutdown_pubkey() }
 205         fn get_channel_keys(&self, inbound: bool) -> EnforcingChannelKeys { EnforcingChannelKeys::new(self.backing.get_channel_keys(inbound)) }
 206
 207         fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
 208                 match *self.override_session_priv.lock().unwrap() {
 209                         Some(key) => (key.clone(), [0; 32]),
 210                         None => self.backing.get_onion_rand()
 211                 }
 212         }
 213
 214         fn get_channel_id(&self) -> [u8; 32] {
 215                 match *self.override_channel_id_priv.lock().unwrap() {
 216                         Some(key) => key.clone(),
 217                         None => self.backing.get_channel_id()
 218                 }
 219         }
 220 }
 221
 222 impl TestKeysInterface {
 223         pub fn new(seed: &[u8; 32], network: Network, logger: Arc<Logger>) -> Self {
 224                 let now = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time went backwards");
 225                 Self {
 226                         backing: keysinterface::KeysManager::new(seed, network, logger, now.as_secs(), now.subsec_nanos()),
 227                         override_session_priv: Mutex::new(None),
 228                         override_channel_id_priv: Mutex::new(None),
 229                 }
 230         }
 231 }