1 //! Utilities that handle persisting Rust-Lightning data to disk via standard filesystem APIs.
3 #![deny(broken_intra_doc_links)]
6 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
8 #![cfg_attr(all(test, feature = "_bench_unstable"), feature(test))]
9 #[cfg(all(test, feature = "_bench_unstable"))] extern crate test;
13 extern crate lightning;
17 use bitcoin::hash_types::{BlockHash, Txid};
18 use bitcoin::hashes::hex::FromHex;
19 use lightning::chain::channelmonitor::ChannelMonitor;
20 use lightning::chain::keysinterface::{Sign, KeysInterface};
21 use lightning::util::ser::{ReadableArgs, Writeable};
22 use lightning::util::persist::KVStorePersister;
26 use std::path::{Path, PathBuf};
28 /// FilesystemPersister persists channel data on disk, where each channel's
29 /// data is stored in a file named after its funding outpoint.
31 /// Warning: this module does the best it can with calls to persist data, but it
32 /// can only guarantee that the data is passed to the drive. It is up to the
33 /// drive manufacturers to do the actual persistence properly, which they often
34 /// don't (especially on consumer-grade hardware). Therefore, it is up to the
35 /// user to validate their entire storage stack, to ensure the writes are
37 /// Corollary: especially when dealing with larger amounts of money, it is best
38 /// practice to have multiple channel data backups and not rely only on one
39 /// FilesystemPersister.
40 pub struct FilesystemPersister {
41 path_to_channel_data: String,
44 impl FilesystemPersister {
45 /// Initialize a new FilesystemPersister and set the path to the individual channels'
47 pub fn new(path_to_channel_data: String) -> Self {
53 /// Get the directory which was provided when this persister was initialized.
54 pub fn get_data_dir(&self) -> String {
55 self.path_to_channel_data.clone()
58 /// Read `ChannelMonitor`s from disk.
59 pub fn read_channelmonitors<Signer: Sign, K: Deref> (
60 &self, keys_manager: K
61 ) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
62 where K::Target: KeysInterface<Signer=Signer> + Sized,
64 let mut path = PathBuf::from(&self.path_to_channel_data);
65 path.push("monitors");
66 if !Path::new(&path).exists() {
67 return Ok(Vec::new());
69 let mut res = Vec::new();
70 for file_option in fs::read_dir(path).unwrap() {
71 let file = file_option.unwrap();
72 let owned_file_name = file.file_name();
73 let filename = owned_file_name.to_str();
74 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
75 return Err(std::io::Error::new(
76 std::io::ErrorKind::InvalidData,
77 "Invalid ChannelMonitor file name",
80 if filename.unwrap().ends_with(".tmp") {
81 // If we were in the middle of committing an new update and crashed, it should be
82 // safe to ignore the update - we should never have returned to the caller and
83 // irrevocably committed to the new state in any way.
87 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
89 return Err(std::io::Error::new(
90 std::io::ErrorKind::InvalidData,
91 "Invalid tx ID in filename",
95 let index = filename.unwrap().split_at(65).1.parse();
97 return Err(std::io::Error::new(
98 std::io::ErrorKind::InvalidData,
99 "Invalid tx index in filename",
103 let contents = fs::read(&file.path())?;
104 let mut buffer = Cursor::new(&contents);
105 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
106 Ok((blockhash, channel_monitor)) => {
107 if channel_monitor.get_funding_txo().0.txid != txid.unwrap() || channel_monitor.get_funding_txo().0.index != index.unwrap() {
108 return Err(std::io::Error::new(std::io::ErrorKind::InvalidData, "ChannelMonitor was stored in the wrong file"));
110 res.push((blockhash, channel_monitor));
112 Err(e) => return Err(std::io::Error::new(
113 std::io::ErrorKind::InvalidData,
114 format!("Failed to deserialize ChannelMonitor: {}", e),
122 impl KVStorePersister for FilesystemPersister {
123 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
124 let mut dest_file = PathBuf::from(self.path_to_channel_data.clone());
126 util::write_to_file(dest_file, object)
132 extern crate lightning;
133 extern crate bitcoin;
134 use crate::FilesystemPersister;
135 use bitcoin::blockdata::block::{Block, BlockHeader};
136 use bitcoin::hashes::hex::FromHex;
138 use lightning::chain::ChannelMonitorUpdateErr;
139 use lightning::chain::chainmonitor::Persist;
140 use lightning::chain::transaction::OutPoint;
141 use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
142 use lightning::ln::features::InitFeatures;
143 use lightning::ln::functional_test_utils::*;
144 use lightning::util::events::{ClosureReason, MessageSendEventsProvider};
145 use lightning::util::test_utils;
147 #[cfg(target_os = "windows")]
149 lightning::get_event_msg,
150 lightning::ln::msgs::ChannelMessageHandler,
153 impl Drop for FilesystemPersister {
155 // We test for invalid directory names, so it's OK if directory removal
157 match fs::remove_dir_all(&self.path_to_channel_data) {
158 Err(e) => println!("Failed to remove test persister directory: {}", e),
164 // Integration-test the FilesystemPersister. Test relaying a few payments
165 // and check that the persisted data is updated the appropriate number of
168 fn test_filesystem_persister() {
169 // Create the nodes, giving them FilesystemPersisters for data persisters.
170 let persister_0 = FilesystemPersister::new("test_filesystem_persister_0".to_string());
171 let persister_1 = FilesystemPersister::new("test_filesystem_persister_1".to_string());
172 let chanmon_cfgs = create_chanmon_cfgs(2);
173 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
174 let chain_mon_0 = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &persister_0, &node_cfgs[0].keys_manager);
175 let chain_mon_1 = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[1].chain_source), &chanmon_cfgs[1].tx_broadcaster, &chanmon_cfgs[1].logger, &chanmon_cfgs[1].fee_estimator, &persister_1, &node_cfgs[1].keys_manager);
176 node_cfgs[0].chain_monitor = chain_mon_0;
177 node_cfgs[1].chain_monitor = chain_mon_1;
178 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
179 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
181 // Check that the persisted channel data is empty before any channels are
183 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
184 assert_eq!(persisted_chan_data_0.len(), 0);
185 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
186 assert_eq!(persisted_chan_data_1.len(), 0);
188 // Helper to make sure the channel is on the expected update ID.
189 macro_rules! check_persisted_data {
190 ($expected_update_id: expr) => {
191 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
192 assert_eq!(persisted_chan_data_0.len(), 1);
193 for (_, mon) in persisted_chan_data_0.iter() {
194 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
196 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
197 assert_eq!(persisted_chan_data_1.len(), 1);
198 for (_, mon) in persisted_chan_data_1.iter() {
199 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
204 // Create some initial channel and check that a channel was persisted.
205 let _ = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
206 check_persisted_data!(0);
208 // Send a few payments and make sure the monitors are updated to the latest.
209 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
210 check_persisted_data!(5);
211 send_payment(&nodes[1], &vec!(&nodes[0])[..], 4000000);
212 check_persisted_data!(10);
214 // Force close because cooperative close doesn't result in any persisted
216 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
217 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
218 check_closed_broadcast!(nodes[0], true);
219 check_added_monitors!(nodes[0], 1);
221 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
222 assert_eq!(node_txn.len(), 1);
224 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
225 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[0].clone()]});
226 check_closed_broadcast!(nodes[1], true);
227 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
228 check_added_monitors!(nodes[1], 1);
230 // Make sure everything is persisted as expected after close.
231 check_persisted_data!(11);
234 // Test that if the persister's path to channel data is read-only, writing a
235 // monitor to it results in the persister returning a PermanentFailure.
236 // Windows ignores the read-only flag for folders, so this test is Unix-only.
237 #[cfg(not(target_os = "windows"))]
239 fn test_readonly_dir_perm_failure() {
240 let persister = FilesystemPersister::new("test_readonly_dir_perm_failure".to_string());
241 fs::create_dir_all(&persister.path_to_channel_data).unwrap();
243 // Set up a dummy channel and force close. This will produce a monitor
244 // that we can then use to test persistence.
245 let chanmon_cfgs = create_chanmon_cfgs(2);
246 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
247 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
248 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
249 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
250 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
251 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
252 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
253 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
254 let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
256 // Set the persister's directory to read-only, which should result in
257 // returning a permanent failure when we then attempt to persist a
259 let path = &persister.path_to_channel_data;
260 let mut perms = fs::metadata(path).unwrap().permissions();
261 perms.set_readonly(true);
262 fs::set_permissions(path, perms).unwrap();
264 let test_txo = OutPoint {
265 txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
268 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
269 Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
270 _ => panic!("unexpected result from persisting new channel")
273 nodes[1].node.get_and_clear_pending_msg_events();
274 added_monitors.clear();
277 // Test that if a persister's directory name is invalid, monitor persistence
279 #[cfg(target_os = "windows")]
281 fn test_fail_on_open() {
282 // Set up a dummy channel and force close. This will produce a monitor
283 // that we can then use to test persistence.
284 let chanmon_cfgs = create_chanmon_cfgs(2);
285 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
286 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
287 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
288 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
289 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
290 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
291 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
292 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
293 let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
295 // Create the persister with an invalid directory name and test that the
296 // channel fails to open because the directories fail to be created. There
297 // don't seem to be invalid filename characters on Unix that Rust doesn't
298 // handle, hence why the test is Windows-only.
299 let persister = FilesystemPersister::new(":<>/".to_string());
301 let test_txo = OutPoint {
302 txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
305 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
306 Err(ChannelMonitorUpdateErr::PermanentFailure) => {},
307 _ => panic!("unexpected result from persisting new channel")
310 nodes[1].node.get_and_clear_pending_msg_events();
311 added_monitors.clear();
315 #[cfg(all(test, feature = "_bench_unstable"))]
320 fn bench_sends(bench: &mut Bencher) {
321 let persister_a = super::FilesystemPersister::new("bench_filesystem_persister_a".to_string());
322 let persister_b = super::FilesystemPersister::new("bench_filesystem_persister_b".to_string());
323 lightning::ln::channelmanager::bench::bench_two_sends(bench, persister_a, persister_b);