1 //! Utilities that handle persisting Rust-Lightning data to disk via standard filesystem APIs.
3 // Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
4 #![deny(broken_intra_doc_links)]
5 #![deny(private_intra_doc_links)]
9 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
11 #[cfg(ldk_bench)] extern crate criterion;
15 extern crate lightning;
19 use bitcoin::hash_types::{BlockHash, Txid};
20 use bitcoin::hashes::hex::FromHex;
21 use lightning::chain::channelmonitor::ChannelMonitor;
22 use lightning::sign::{EntropySource, SignerProvider};
23 use lightning::util::ser::{ReadableArgs, Writeable};
24 use lightning::util::persist::KVStorePersister;
28 use std::path::{Path, PathBuf};
30 /// FilesystemPersister persists channel data on disk, where each channel's
31 /// data is stored in a file named after its funding outpoint.
33 /// Warning: this module does the best it can with calls to persist data, but it
34 /// can only guarantee that the data is passed to the drive. It is up to the
35 /// drive manufacturers to do the actual persistence properly, which they often
36 /// don't (especially on consumer-grade hardware). Therefore, it is up to the
37 /// user to validate their entire storage stack, to ensure the writes are
39 /// Corollary: especially when dealing with larger amounts of money, it is best
40 /// practice to have multiple channel data backups and not rely only on one
41 /// FilesystemPersister.
42 pub struct FilesystemPersister {
43 path_to_channel_data: String,
46 impl FilesystemPersister {
47 /// Initialize a new FilesystemPersister and set the path to the individual channels'
49 pub fn new(path_to_channel_data: String) -> Self {
55 /// Get the directory which was provided when this persister was initialized.
56 pub fn get_data_dir(&self) -> String {
57 self.path_to_channel_data.clone()
60 /// Read `ChannelMonitor`s from disk.
61 pub fn read_channelmonitors<ES: Deref, SP: Deref> (
62 &self, entropy_source: ES, signer_provider: SP
63 ) -> std::io::Result<Vec<(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>>
65 ES::Target: EntropySource + Sized,
66 SP::Target: SignerProvider + Sized
68 let mut path = PathBuf::from(&self.path_to_channel_data);
69 path.push("monitors");
70 if !Path::new(&path).exists() {
71 return Ok(Vec::new());
73 let mut res = Vec::new();
74 for file_option in fs::read_dir(path)? {
75 let file = file_option.unwrap();
76 let owned_file_name = file.file_name();
77 let filename = owned_file_name.to_str()
78 .ok_or_else(|| std::io::Error::new(std::io::ErrorKind::InvalidData,
79 "File name is not a valid utf8 string"))?;
80 if !filename.is_ascii() || filename.len() < 65 {
81 return Err(std::io::Error::new(
82 std::io::ErrorKind::InvalidData,
83 "Invalid ChannelMonitor file name",
86 if filename.ends_with(".tmp") {
87 // If we were in the middle of committing an new update and crashed, it should be
88 // safe to ignore the update - we should never have returned to the caller and
89 // irrevocably committed to the new state in any way.
93 let txid: Txid = Txid::from_hex(filename.split_at(64).0)
94 .map_err(|_| std::io::Error::new(
95 std::io::ErrorKind::InvalidData,
96 "Invalid tx ID in filename",
99 let index: u16 = filename.split_at(65).1.parse()
100 .map_err(|_| std::io::Error::new(
101 std::io::ErrorKind::InvalidData,
102 "Invalid tx index in filename",
105 let contents = fs::read(&file.path())?;
106 let mut buffer = Cursor::new(&contents);
107 match <(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>::read(&mut buffer, (&*entropy_source, &*signer_provider)) {
108 Ok((blockhash, channel_monitor)) => {
109 if channel_monitor.get_funding_txo().0.txid != txid || channel_monitor.get_funding_txo().0.index != index {
110 return Err(std::io::Error::new(std::io::ErrorKind::InvalidData,
111 "ChannelMonitor was stored in the wrong file"));
113 res.push((blockhash, channel_monitor));
115 Err(e) => return Err(std::io::Error::new(
116 std::io::ErrorKind::InvalidData,
117 format!("Failed to deserialize ChannelMonitor: {}", e),
125 impl KVStorePersister for FilesystemPersister {
126 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
127 let mut dest_file = PathBuf::from(self.path_to_channel_data.clone());
129 util::write_to_file(dest_file, object)
135 extern crate lightning;
136 extern crate bitcoin;
137 use crate::FilesystemPersister;
138 use bitcoin::hashes::hex::FromHex;
140 use lightning::chain::ChannelMonitorUpdateStatus;
141 use lightning::chain::chainmonitor::Persist;
142 use lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID;
143 use lightning::chain::transaction::OutPoint;
144 use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
145 use lightning::events::{ClosureReason, MessageSendEventsProvider};
146 use lightning::ln::functional_test_utils::*;
147 use lightning::util::test_utils;
149 #[cfg(target_os = "windows")]
151 lightning::get_event_msg,
152 lightning::ln::msgs::ChannelMessageHandler,
155 impl Drop for FilesystemPersister {
157 // We test for invalid directory names, so it's OK if directory removal
159 match fs::remove_dir_all(&self.path_to_channel_data) {
160 Err(e) => println!("Failed to remove test persister directory: {}", e),
167 fn test_if_monitors_is_not_dir() {
168 let persister = FilesystemPersister::new("test_monitors_is_not_dir".to_string());
170 fs::create_dir_all(&persister.path_to_channel_data).unwrap();
171 let mut path = std::path::PathBuf::from(&persister.path_to_channel_data);
172 path.push("monitors");
173 fs::File::create(path).unwrap();
175 let chanmon_cfgs = create_chanmon_cfgs(1);
176 let mut node_cfgs = create_node_cfgs(1, &chanmon_cfgs);
177 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, node_cfgs[0].keys_manager);
178 node_cfgs[0].chain_monitor = chain_mon_0;
179 let node_chanmgrs = create_node_chanmgrs(1, &node_cfgs, &[None]);
180 let nodes = create_network(1, &node_cfgs, &node_chanmgrs);
182 // Check that read_channelmonitors() returns error if monitors/ is not a
184 assert!(persister.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).is_err());
187 // Integration-test the FilesystemPersister. Test relaying a few payments
188 // and check that the persisted data is updated the appropriate number of
191 fn test_filesystem_persister() {
192 // Create the nodes, giving them FilesystemPersisters for data persisters.
193 let persister_0 = FilesystemPersister::new("test_filesystem_persister_0".to_string());
194 let persister_1 = FilesystemPersister::new("test_filesystem_persister_1".to_string());
195 let chanmon_cfgs = create_chanmon_cfgs(2);
196 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
197 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);
198 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);
199 node_cfgs[0].chain_monitor = chain_mon_0;
200 node_cfgs[1].chain_monitor = chain_mon_1;
201 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
202 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
204 // Check that the persisted channel data is empty before any channels are
206 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
207 assert_eq!(persisted_chan_data_0.len(), 0);
208 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
209 assert_eq!(persisted_chan_data_1.len(), 0);
211 // Helper to make sure the channel is on the expected update ID.
212 macro_rules! check_persisted_data {
213 ($expected_update_id: expr) => {
214 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
215 assert_eq!(persisted_chan_data_0.len(), 1);
216 for (_, mon) in persisted_chan_data_0.iter() {
217 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
219 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
220 assert_eq!(persisted_chan_data_1.len(), 1);
221 for (_, mon) in persisted_chan_data_1.iter() {
222 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
227 // Create some initial channel and check that a channel was persisted.
228 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
229 check_persisted_data!(0);
231 // Send a few payments and make sure the monitors are updated to the latest.
232 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
233 check_persisted_data!(5);
234 send_payment(&nodes[1], &vec!(&nodes[0])[..], 4000000);
235 check_persisted_data!(10);
237 // Force close because cooperative close doesn't result in any persisted
239 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
240 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
241 check_closed_broadcast!(nodes[0], true);
242 check_added_monitors!(nodes[0], 1);
244 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
245 assert_eq!(node_txn.len(), 1);
247 connect_block(&nodes[1], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![node_txn[0].clone(), node_txn[0].clone()]));
248 check_closed_broadcast!(nodes[1], true);
249 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
250 check_added_monitors!(nodes[1], 1);
252 // Make sure everything is persisted as expected after close.
253 check_persisted_data!(CLOSED_CHANNEL_UPDATE_ID);
256 // Test that if the persister's path to channel data is read-only, writing a
257 // monitor to it results in the persister returning a PermanentFailure.
258 // Windows ignores the read-only flag for folders, so this test is Unix-only.
259 #[cfg(not(target_os = "windows"))]
261 fn test_readonly_dir_perm_failure() {
262 let persister = FilesystemPersister::new("test_readonly_dir_perm_failure".to_string());
263 fs::create_dir_all(&persister.path_to_channel_data).unwrap();
265 // Set up a dummy channel and force close. This will produce a monitor
266 // that we can then use to test persistence.
267 let chanmon_cfgs = create_chanmon_cfgs(2);
268 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
269 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
270 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
271 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
272 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
273 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
274 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
275 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
276 let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
278 // Set the persister's directory to read-only, which should result in
279 // returning a permanent failure when we then attempt to persist a
281 let path = &persister.path_to_channel_data;
282 let mut perms = fs::metadata(path).unwrap().permissions();
283 perms.set_readonly(true);
284 fs::set_permissions(path, perms).unwrap();
286 let test_txo = OutPoint {
287 txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
290 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
291 ChannelMonitorUpdateStatus::PermanentFailure => {},
292 _ => panic!("unexpected result from persisting new channel")
295 nodes[1].node.get_and_clear_pending_msg_events();
296 added_monitors.clear();
299 // Test that if a persister's directory name is invalid, monitor persistence
301 #[cfg(target_os = "windows")]
303 fn test_fail_on_open() {
304 // Set up a dummy channel and force close. This will produce a monitor
305 // that we can then use to test persistence.
306 let chanmon_cfgs = create_chanmon_cfgs(2);
307 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
308 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
309 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
310 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
311 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
312 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
313 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
314 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
315 let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
317 // Create the persister with an invalid directory name and test that the
318 // channel fails to open because the directories fail to be created. There
319 // don't seem to be invalid filename characters on Unix that Rust doesn't
320 // handle, hence why the test is Windows-only.
321 let persister = FilesystemPersister::new(":<>/".to_string());
323 let test_txo = OutPoint {
324 txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
327 match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
328 ChannelMonitorUpdateStatus::PermanentFailure => {},
329 _ => panic!("unexpected result from persisting new channel")
332 nodes[1].node.get_and_clear_pending_msg_events();
333 added_monitors.clear();
340 use criterion::Criterion;
343 pub fn bench_sends(bench: &mut Criterion) {
344 let persister_a = super::FilesystemPersister::new("bench_filesystem_persister_a".to_string());
345 let persister_b = super::FilesystemPersister::new("bench_filesystem_persister_b".to_string());
346 lightning::ln::channelmanager::bench::bench_two_sends(
347 bench, "bench_filesystem_persisted_sends", persister_a, persister_b);