-//! Utilities that handle persisting Rust-Lightning data to disk via standard filesystem APIs.
+//! Provides utilities for LDK data persistence and retrieval.
-// Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
-#![deny(broken_intra_doc_links)]
-#![deny(private_intra_doc_links)]
+#![deny(rustdoc::broken_intra_doc_links)]
+#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#[cfg(ldk_bench)] extern crate criterion;
-mod util;
+pub mod fs_store;
-extern crate lightning;
-extern crate bitcoin;
-extern crate libc;
-
-use bitcoin::hash_types::{BlockHash, Txid};
-use bitcoin::hashes::hex::FromHex;
-use lightning::chain::channelmonitor::ChannelMonitor;
-use lightning::sign::{EntropySource, SignerProvider};
-use lightning::util::ser::{ReadableArgs, Writeable};
-use lightning::util::persist::KVStorePersister;
-use std::fs;
-use std::io::Cursor;
-use std::ops::Deref;
-use std::path::{Path, PathBuf};
-
-/// FilesystemPersister persists channel data on disk, where each channel's
-/// data is stored in a file named after its funding outpoint.
-///
-/// Warning: this module does the best it can with calls to persist data, but it
-/// can only guarantee that the data is passed to the drive. It is up to the
-/// drive manufacturers to do the actual persistence properly, which they often
-/// don't (especially on consumer-grade hardware). Therefore, it is up to the
-/// user to validate their entire storage stack, to ensure the writes are
-/// persistent.
-/// Corollary: especially when dealing with larger amounts of money, it is best
-/// practice to have multiple channel data backups and not rely only on one
-/// FilesystemPersister.
-pub struct FilesystemPersister {
- path_to_channel_data: String,
-}
-
-impl FilesystemPersister {
- /// Initialize a new FilesystemPersister and set the path to the individual channels'
- /// files.
- pub fn new(path_to_channel_data: String) -> Self {
- Self {
- path_to_channel_data,
- }
- }
-
- /// Get the directory which was provided when this persister was initialized.
- pub fn get_data_dir(&self) -> String {
- self.path_to_channel_data.clone()
- }
-
- /// Read `ChannelMonitor`s from disk.
- pub fn read_channelmonitors<ES: Deref, SP: Deref> (
- &self, entropy_source: ES, signer_provider: SP
- ) -> std::io::Result<Vec<(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>>
- where
- ES::Target: EntropySource + Sized,
- SP::Target: SignerProvider + Sized
- {
- let mut path = PathBuf::from(&self.path_to_channel_data);
- path.push("monitors");
- if !Path::new(&path).exists() {
- return Ok(Vec::new());
- }
- let mut res = Vec::new();
- for file_option in fs::read_dir(path)? {
- let file = file_option.unwrap();
- let owned_file_name = file.file_name();
- let filename = owned_file_name.to_str()
- .ok_or_else(|| std::io::Error::new(std::io::ErrorKind::InvalidData,
- "File name is not a valid utf8 string"))?;
- if !filename.is_ascii() || filename.len() < 65 {
- return Err(std::io::Error::new(
- std::io::ErrorKind::InvalidData,
- "Invalid ChannelMonitor file name",
- ));
- }
- if filename.ends_with(".tmp") {
- // If we were in the middle of committing an new update and crashed, it should be
- // safe to ignore the update - we should never have returned to the caller and
- // irrevocably committed to the new state in any way.
- continue;
- }
-
- let txid: Txid = Txid::from_hex(filename.split_at(64).0)
- .map_err(|_| std::io::Error::new(
- std::io::ErrorKind::InvalidData,
- "Invalid tx ID in filename",
- ))?;
-
- let index: u16 = filename.split_at(65).1.parse()
- .map_err(|_| std::io::Error::new(
- std::io::ErrorKind::InvalidData,
- "Invalid tx index in filename",
- ))?;
-
- let contents = fs::read(&file.path())?;
- let mut buffer = Cursor::new(&contents);
- match <(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>::read(&mut buffer, (&*entropy_source, &*signer_provider)) {
- Ok((blockhash, channel_monitor)) => {
- if channel_monitor.get_funding_txo().0.txid != txid || channel_monitor.get_funding_txo().0.index != index {
- return Err(std::io::Error::new(std::io::ErrorKind::InvalidData,
- "ChannelMonitor was stored in the wrong file"));
- }
- res.push((blockhash, channel_monitor));
- }
- Err(e) => return Err(std::io::Error::new(
- std::io::ErrorKind::InvalidData,
- format!("Failed to deserialize ChannelMonitor: {}", e),
- ))
- }
- }
- Ok(res)
- }
-}
-
-impl KVStorePersister for FilesystemPersister {
- fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
- let mut dest_file = PathBuf::from(self.path_to_channel_data.clone());
- dest_file.push(key);
- util::write_to_file(dest_file, object)
- }
-}
+mod utils;
#[cfg(test)]
-mod tests {
- extern crate lightning;
- extern crate bitcoin;
- use crate::FilesystemPersister;
- use bitcoin::hashes::hex::FromHex;
- use bitcoin::Txid;
- use lightning::chain::ChannelMonitorUpdateStatus;
- use lightning::chain::chainmonitor::Persist;
- use lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID;
- use lightning::chain::transaction::OutPoint;
- use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
- use lightning::events::{ClosureReason, MessageSendEventsProvider};
- use lightning::ln::functional_test_utils::*;
- use lightning::util::test_utils;
- use std::fs;
- #[cfg(target_os = "windows")]
- use {
- lightning::get_event_msg,
- lightning::ln::msgs::ChannelMessageHandler,
- };
-
- impl Drop for FilesystemPersister {
- fn drop(&mut self) {
- // We test for invalid directory names, so it's OK if directory removal
- // fails.
- match fs::remove_dir_all(&self.path_to_channel_data) {
- Err(e) => println!("Failed to remove test persister directory: {}", e),
- _ => {}
- }
- }
- }
-
- #[test]
- fn test_if_monitors_is_not_dir() {
- let persister = FilesystemPersister::new("test_monitors_is_not_dir".to_string());
-
- fs::create_dir_all(&persister.path_to_channel_data).unwrap();
- let mut path = std::path::PathBuf::from(&persister.path_to_channel_data);
- path.push("monitors");
- fs::File::create(path).unwrap();
-
- let chanmon_cfgs = create_chanmon_cfgs(1);
- let mut node_cfgs = create_node_cfgs(1, &chanmon_cfgs);
- 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);
- node_cfgs[0].chain_monitor = chain_mon_0;
- let node_chanmgrs = create_node_chanmgrs(1, &node_cfgs, &[None]);
- let nodes = create_network(1, &node_cfgs, &node_chanmgrs);
-
- // Check that read_channelmonitors() returns error if monitors/ is not a
- // directory.
- assert!(persister.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).is_err());
- }
-
- // Integration-test the FilesystemPersister. Test relaying a few payments
- // and check that the persisted data is updated the appropriate number of
- // times.
- #[test]
- fn test_filesystem_persister() {
- // Create the nodes, giving them FilesystemPersisters for data persisters.
- let persister_0 = FilesystemPersister::new("test_filesystem_persister_0".to_string());
- let persister_1 = FilesystemPersister::new("test_filesystem_persister_1".to_string());
- let chanmon_cfgs = create_chanmon_cfgs(2);
- let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
- 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);
- 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);
- node_cfgs[0].chain_monitor = chain_mon_0;
- node_cfgs[1].chain_monitor = chain_mon_1;
- let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
- let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
-
- // Check that the persisted channel data is empty before any channels are
- // open.
- let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
- assert_eq!(persisted_chan_data_0.len(), 0);
- let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
- assert_eq!(persisted_chan_data_1.len(), 0);
-
- // Helper to make sure the channel is on the expected update ID.
- macro_rules! check_persisted_data {
- ($expected_update_id: expr) => {
- persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
- assert_eq!(persisted_chan_data_0.len(), 1);
- for (_, mon) in persisted_chan_data_0.iter() {
- assert_eq!(mon.get_latest_update_id(), $expected_update_id);
- }
- persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
- assert_eq!(persisted_chan_data_1.len(), 1);
- for (_, mon) in persisted_chan_data_1.iter() {
- assert_eq!(mon.get_latest_update_id(), $expected_update_id);
- }
- }
- }
-
- // Create some initial channel and check that a channel was persisted.
- let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
- check_persisted_data!(0);
-
- // Send a few payments and make sure the monitors are updated to the latest.
- send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
- check_persisted_data!(5);
- send_payment(&nodes[1], &vec!(&nodes[0])[..], 4000000);
- check_persisted_data!(10);
-
- // Force close because cooperative close doesn't result in any persisted
- // updates.
- nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
- check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
- check_closed_broadcast!(nodes[0], true);
- check_added_monitors!(nodes[0], 1);
-
- let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
- assert_eq!(node_txn.len(), 1);
-
- connect_block(&nodes[1], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![node_txn[0].clone(), node_txn[0].clone()]));
- check_closed_broadcast!(nodes[1], true);
- check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
- check_added_monitors!(nodes[1], 1);
-
- // Make sure everything is persisted as expected after close.
- check_persisted_data!(CLOSED_CHANNEL_UPDATE_ID);
- }
-
- // Test that if the persister's path to channel data is read-only, writing a
- // monitor to it results in the persister returning a PermanentFailure.
- // Windows ignores the read-only flag for folders, so this test is Unix-only.
- #[cfg(not(target_os = "windows"))]
- #[test]
- fn test_readonly_dir_perm_failure() {
- let persister = FilesystemPersister::new("test_readonly_dir_perm_failure".to_string());
- fs::create_dir_all(&persister.path_to_channel_data).unwrap();
-
- // Set up a dummy channel and force close. This will produce a monitor
- // that we can then use to test persistence.
- let chanmon_cfgs = create_chanmon_cfgs(2);
- let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
- let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
- let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
- let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
- nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
- check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
- let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
- let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
- let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
-
- // Set the persister's directory to read-only, which should result in
- // returning a permanent failure when we then attempt to persist a
- // channel update.
- let path = &persister.path_to_channel_data;
- let mut perms = fs::metadata(path).unwrap().permissions();
- perms.set_readonly(true);
- fs::set_permissions(path, perms).unwrap();
-
- let test_txo = OutPoint {
- txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
- index: 0
- };
- match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
- ChannelMonitorUpdateStatus::PermanentFailure => {},
- _ => panic!("unexpected result from persisting new channel")
- }
-
- nodes[1].node.get_and_clear_pending_msg_events();
- added_monitors.clear();
- }
-
- // Test that if a persister's directory name is invalid, monitor persistence
- // will fail.
- #[cfg(target_os = "windows")]
- #[test]
- fn test_fail_on_open() {
- // Set up a dummy channel and force close. This will produce a monitor
- // that we can then use to test persistence.
- let chanmon_cfgs = create_chanmon_cfgs(2);
- let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
- let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
- let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
- let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
- nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
- check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
- let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
- let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
- let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
-
- // Create the persister with an invalid directory name and test that the
- // channel fails to open because the directories fail to be created. There
- // don't seem to be invalid filename characters on Unix that Rust doesn't
- // handle, hence why the test is Windows-only.
- let persister = FilesystemPersister::new(":<>/".to_string());
-
- let test_txo = OutPoint {
- txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(),
- index: 0
- };
- match persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
- ChannelMonitorUpdateStatus::PermanentFailure => {},
- _ => panic!("unexpected result from persisting new channel")
- }
-
- nodes[1].node.get_and_clear_pending_msg_events();
- added_monitors.clear();
- }
-}
-
-#[cfg(ldk_bench)]
-/// Benches
-pub mod bench {
- use criterion::Criterion;
-
- /// Bench!
- pub fn bench_sends(bench: &mut Criterion) {
- let persister_a = super::FilesystemPersister::new("bench_filesystem_persister_a".to_string());
- let persister_b = super::FilesystemPersister::new("bench_filesystem_persister_b".to_string());
- lightning::ln::channelmanager::bench::bench_two_sends(
- bench, "bench_filesystem_persisted_sends", persister_a, persister_b);
- }
-}
+mod test_utils;