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