1 use chain::chaininterface;
2 use chain::chaininterface::{ConfirmationTarget, ChainError, ChainWatchInterface};
3 use chain::transaction::OutPoint;
4 use chain::keysinterface;
5 use ln::channelmonitor;
6 use ln::features::InitFeatures;
8 use ln::msgs::LightningError;
9 use ln::channelmonitor::HTLCUpdate;
10 use util::enforcing_trait_impls::EnforcingChannelKeys;
12 use util::logger::{Logger, Level, Record};
13 use util::ser::{Readable, Writer, Writeable};
15 use bitcoin::blockdata::transaction::Transaction;
16 use bitcoin::blockdata::script::{Builder, Script};
17 use bitcoin::blockdata::block::Block;
18 use bitcoin::blockdata::opcodes;
19 use bitcoin::network::constants::Network;
20 use bitcoin::hash_types::{Txid, BlockHash};
22 use bitcoin::secp256k1::{SecretKey, PublicKey};
24 use std::time::{SystemTime, UNIX_EPOCH};
27 use std::collections::HashMap;
29 pub struct TestVecWriter(pub Vec<u8>);
30 impl Writer for TestVecWriter {
31 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
32 self.0.extend_from_slice(buf);
35 fn size_hint(&mut self, size: usize) {
36 self.0.reserve_exact(size);
40 pub struct TestFeeEstimator {
43 impl chaininterface::FeeEstimator for TestFeeEstimator {
44 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u64 {
49 pub struct TestChannelMonitor<'a> {
50 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>>,
51 pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64)>>,
52 pub simple_monitor: channelmonitor::SimpleManyChannelMonitor<OutPoint, EnforcingChannelKeys, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a ChainWatchInterface>,
53 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
54 // If this is set to Some(), after the next return, we'll always return this until update_ret
56 pub next_update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
58 impl<'a> TestChannelMonitor<'a> {
59 pub fn new(chain_monitor: &'a chaininterface::ChainWatchInterface, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator) -> Self {
61 added_monitors: Mutex::new(Vec::new()),
62 latest_monitor_update_id: Mutex::new(HashMap::new()),
63 simple_monitor: channelmonitor::SimpleManyChannelMonitor::new(chain_monitor, broadcaster, logger, fee_estimator),
64 update_ret: Mutex::new(Ok(())),
65 next_update_ret: Mutex::new(None),
69 impl<'a> channelmonitor::ManyChannelMonitor<EnforcingChannelKeys> for TestChannelMonitor<'a> {
70 fn add_monitor(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
71 // At every point where we get a monitor update, we should be able to send a useful monitor
72 // to a watchtower and disk...
73 let mut w = TestVecWriter(Vec::new());
74 monitor.write_for_disk(&mut w).unwrap();
75 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
76 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
77 assert!(new_monitor == monitor);
78 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, monitor.get_latest_update_id()));
79 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
80 assert!(self.simple_monitor.add_monitor(funding_txo, new_monitor).is_ok());
82 let ret = self.update_ret.lock().unwrap().clone();
83 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
84 *self.update_ret.lock().unwrap() = next_ret;
89 fn update_monitor(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
90 // Every monitor update should survive roundtrip
91 let mut w = TestVecWriter(Vec::new());
92 update.write(&mut w).unwrap();
93 assert!(channelmonitor::ChannelMonitorUpdate::read(
94 &mut ::std::io::Cursor::new(&w.0)).unwrap() == update);
96 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, update.update_id));
97 assert!(self.simple_monitor.update_monitor(funding_txo, update).is_ok());
98 // At every point where we get a monitor update, we should be able to send a useful monitor
99 // to a watchtower and disk...
100 let monitors = self.simple_monitor.monitors.lock().unwrap();
101 let monitor = monitors.get(&funding_txo).unwrap();
103 monitor.write_for_disk(&mut w).unwrap();
104 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
105 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
106 assert!(new_monitor == *monitor);
107 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
109 let ret = self.update_ret.lock().unwrap().clone();
110 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
111 *self.update_ret.lock().unwrap() = next_ret;
116 fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate> {
117 return self.simple_monitor.get_and_clear_pending_htlcs_updated();
121 pub struct TestBroadcaster {
122 pub txn_broadcasted: Mutex<Vec<Transaction>>,
124 impl chaininterface::BroadcasterInterface for TestBroadcaster {
125 fn broadcast_transaction(&self, tx: &Transaction) {
126 self.txn_broadcasted.lock().unwrap().push(tx.clone());
130 pub struct TestChannelMessageHandler {
131 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
134 impl TestChannelMessageHandler {
135 pub fn new() -> Self {
136 TestChannelMessageHandler {
137 pending_events: Mutex::new(Vec::new()),
142 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
143 fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
144 fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
145 fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
146 fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
147 fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
148 fn handle_shutdown(&self, _their_node_id: &PublicKey, _msg: &msgs::Shutdown) {}
149 fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
150 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
151 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
152 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
153 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
154 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
155 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
156 fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
157 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
158 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
159 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
160 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
161 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
164 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
165 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
166 let mut pending_events = self.pending_events.lock().unwrap();
167 let mut ret = Vec::new();
168 mem::swap(&mut ret, &mut *pending_events);
173 pub struct TestRoutingMessageHandler {
174 request_full_sync: bool,
177 impl TestRoutingMessageHandler {
178 pub fn new() -> Self {
179 TestRoutingMessageHandler {
180 request_full_sync: false,
184 pub fn set_request_full_sync(mut self) -> Self {
185 self.request_full_sync = true;
189 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
190 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, LightningError> {
191 Err(LightningError { err: "", action: msgs::ErrorAction::IgnoreError })
193 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, LightningError> {
194 Err(LightningError { err: "", action: msgs::ErrorAction::IgnoreError })
196 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, LightningError> {
197 Err(LightningError { err: "", action: msgs::ErrorAction::IgnoreError })
199 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
200 fn get_next_channel_announcements(&self, _starting_point: u64, _batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
203 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
206 fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool {
207 self.request_full_sync
211 pub struct TestLogger {
214 pub lines: Mutex<HashMap<(String, String), usize>>,
218 pub fn new() -> TestLogger {
219 Self::with_id("".to_owned())
221 pub fn with_id(id: String) -> TestLogger {
225 lines: Mutex::new(HashMap::new())
228 pub fn enable(&mut self, level: Level) {
231 pub fn assert_log(&self, module: String, line: String, count: usize) {
232 let log_entries = self.lines.lock().unwrap();
233 assert_eq!(log_entries.get(&(module, line)), Some(&count));
237 impl Logger for TestLogger {
238 fn log(&self, record: &Record) {
239 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
240 if self.level >= record.level {
241 println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
246 pub struct TestKeysInterface {
247 backing: keysinterface::KeysManager,
248 pub override_session_priv: Mutex<Option<SecretKey>>,
249 pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
252 impl keysinterface::KeysInterface for TestKeysInterface {
253 type ChanKeySigner = EnforcingChannelKeys;
255 fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
256 fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
257 fn get_shutdown_pubkey(&self) -> PublicKey { self.backing.get_shutdown_pubkey() }
258 fn get_channel_keys(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
259 EnforcingChannelKeys::new(self.backing.get_channel_keys(inbound, channel_value_satoshis))
262 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) {
263 match *self.override_session_priv.lock().unwrap() {
264 Some(key) => (key.clone(), [0; 32]),
265 None => self.backing.get_onion_rand()
269 fn get_channel_id(&self) -> [u8; 32] {
270 match *self.override_channel_id_priv.lock().unwrap() {
271 Some(key) => key.clone(),
272 None => self.backing.get_channel_id()
277 impl TestKeysInterface {
278 pub fn new(seed: &[u8; 32], network: Network) -> Self {
279 let now = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time went backwards");
281 backing: keysinterface::KeysManager::new(seed, network, now.as_secs(), now.subsec_nanos()),
282 override_session_priv: Mutex::new(None),
283 override_channel_id_priv: Mutex::new(None),
286 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, user_id_1: u64, user_id_2: u64) -> EnforcingChannelKeys {
287 EnforcingChannelKeys::new(self.backing.derive_channel_keys(channel_value_satoshis, user_id_1, user_id_2))
291 pub struct TestChainWatcher {
292 pub utxo_ret: Mutex<Result<(Script, u64), ChainError>>,
295 impl TestChainWatcher {
296 pub fn new() -> Self {
297 let script = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
298 Self { utxo_ret: Mutex::new(Ok((script, u64::max_value()))) }
302 impl ChainWatchInterface for TestChainWatcher {
303 fn install_watch_tx(&self, _txid: &Txid, _script_pub_key: &Script) { }
304 fn install_watch_outpoint(&self, _outpoint: (Txid, u32), _out_script: &Script) { }
305 fn watch_all_txn(&self) { }
306 fn filter_block<'a>(&self, _block: &'a Block) -> (Vec<&'a Transaction>, Vec<u32>) {
307 (Vec::new(), Vec::new())
309 fn reentered(&self) -> usize { 0 }
311 fn get_chain_utxo(&self, _genesis_hash: BlockHash, _unspent_tx_output_identifier: u64) -> Result<(Script, u64), ChainError> {
312 self.utxo_ret.lock().unwrap().clone()