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