persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 1 commit into from
Apr 9, 2021
Merged

persister: Expose method to read ChannelMonitors from disk #863

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 62 additions & 46 deletions lightning-persister/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
lightning::util::ser::ReadableArgs,
bitcoin::{BlockHash, Txid},
bitcoin::hashes::hex::FromHex,
std::collections::HashMap,
std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
util::write_to_file(path, "manager".to_string(), manager)
}

#[cfg(test)]
fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
return Err(ChannelMonitorUpdateErr::PermanentFailure);
/// Read `ChannelMonitor`s from disk.
pub fn read_channelmonitors<Signer: Sign, K: Deref> (
&self, keys_manager: K
) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
where K::Target: KeysInterface<Signer=Signer> + Sized
{
let path = self.path_to_monitor_data();
if !Path::new(&path).exists() {
return Ok(HashMap::new());

@jkczyzjkczyzApr 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.

@TheBlueMattTheBlueMattApr 7, 2021

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?

@jkczyzjkczyzApr 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).

}
let mut outpoint_to_channelmonitor = HashMap::new();
for file_option in fs::read_dir(path).unwrap() {
let file = file_option.unwrap();
let owned_file_name = file.file_name();
let filename = owned_file_name.to_str();
if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
"Invalid ChannelMonitor file name",
));
}
let mut res = HashMap::new();
for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
let file = file_option.unwrap();
let owned_file_name = file.file_name();
let filename = owned_file_name.to_str();
if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
return Err(ChannelMonitorUpdateErr::PermanentFailure);
}

let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
if txid.is_err() {
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
"Invalid tx ID in filename",
));
}

let contents = fs::read(&file.path());
if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
let index = filename.unwrap().split_at(65).1.parse();
if index.is_err() {
return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
"Invalid tx index in filename",
));
}

if let Ok((_, loaded_monitor)) =
<(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
} else {
return Err(ChannelMonitorUpdateErr::PermanentFailure);
}
let contents = fs::read(&file.path())?;
let mut buffer = Cursor::new(&contents);
match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
Ok((blockhash, channel_monitor)) => {
outpoint_to_channelmonitor.insert(
OutPoint { txid: txid.unwrap(), index: index.unwrap() },
(blockhash, channel_monitor),
);
}
Err(e) => return Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
format!("Failed to deserialize ChannelMonitor: {}", e),
))
}
Ok(res)
}
Ok(outpoint_to_channelmonitor)
}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

// Check that the persisted channel data is empty before any channels are
// open.
let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
assert_eq!(persisted_chan_data_0.keys().len(), 0);
let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
assert_eq!(persisted_chan_data_0.keys().len(), 1);
for mon in persisted_chan_data_0.values() {
for (_, mon) in persisted_chan_data_0.values() {
assert_eq!(mon.get_latest_update_id(), $expected_update_id);
}
persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
assert_eq!(persisted_chan_data_1.keys().len(), 1);
for mon in persisted_chan_data_1.values() {
for (_, mon) in persisted_chan_data_1.values() {
assert_eq!(mon.get_latest_update_id(), $expected_update_id);
}
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 9, 2021
 Merged


persister: Expose method to read ChannelMonitors from disk
#863
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


108 changes: 62 additions & 46 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
	lightning::util::ser::ReadableArgs,
	bitcoin::{BlockHash, Txid},
	bitcoin::hashes::hex::FromHex,
	std::collections::HashMap,
	std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
 util::write_to_file(path, "manager".to_string(), manager)
	}

	#[cfg(test)]
	fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
 Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
 if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized
	{
 let path = self.path_to_monitor_data();
 if !Path::new(&path).exists() {
 return Ok(HashMap::new());
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.
@TheBlueMattTheBlueMattApr 7, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).
 }
 let mut outpoint_to_channelmonitor = HashMap::new();
 for file_option in fs::read_dir(path).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid ChannelMonitor file name",
 ));
 }
 let mut res = HashMap::new();
 for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }

 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

 let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
 if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx ID in filename",
 ));
 }

 let contents = fs::read(&file.path());
 if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let index = filename.unwrap().split_at(65).1.parse();
 if index.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx index in filename",
 ));
 }

 if let Ok((_, loaded_monitor)) =
 <(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
 res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
 } else {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }
 let contents = fs::read(&file.path())?;
 let mut buffer = Cursor::new(&contents);
 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
 Ok((blockhash, channel_monitor)) => {
 outpoint_to_channelmonitor.insert(
 OutPoint { txid: txid.unwrap(), index: index.unwrap() },
 (blockhash, channel_monitor),
 );
 }
 Err(e) => return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 format!("Failed to deserialize ChannelMonitor: {}", e),
 ))
 }
 Ok(res)
 }
 Ok(outpoint_to_channelmonitor)
	}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

 // Check that the persisted channel data is empty before any channels are
 // open.
 let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 0);
 let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 1);
 for mon in persisted_chan_data_0.values() {
 for (_, mon) in persisted_chan_data_0.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().len(), 1);
 for mon in persisted_chan_data_1.values() {
 for (_, mon) in persisted_chan_data_1.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 9, 2021
 Merged


persister: Expose method to read ChannelMonitors from disk
#863
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


108 changes: 62 additions & 46 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
	lightning::util::ser::ReadableArgs,
	bitcoin::{BlockHash, Txid},
	bitcoin::hashes::hex::FromHex,
	std::collections::HashMap,
	std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
 util::write_to_file(path, "manager".to_string(), manager)
	}

	#[cfg(test)]
	fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
 Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
 if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized
	{
 let path = self.path_to_monitor_data();
 if !Path::new(&path).exists() {
 return Ok(HashMap::new());
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.
@TheBlueMattTheBlueMattApr 7, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).
 }
 let mut outpoint_to_channelmonitor = HashMap::new();
 for file_option in fs::read_dir(path).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid ChannelMonitor file name",
 ));
 }
 let mut res = HashMap::new();
 for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }

 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

 let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
 if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx ID in filename",
 ));
 }

 let contents = fs::read(&file.path());
 if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let index = filename.unwrap().split_at(65).1.parse();
 if index.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx index in filename",
 ));
 }

 if let Ok((_, loaded_monitor)) =
 <(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
 res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
 } else {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }
 let contents = fs::read(&file.path())?;
 let mut buffer = Cursor::new(&contents);
 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
 Ok((blockhash, channel_monitor)) => {
 outpoint_to_channelmonitor.insert(
 OutPoint { txid: txid.unwrap(), index: index.unwrap() },
 (blockhash, channel_monitor),
 );
 }
 Err(e) => return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 format!("Failed to deserialize ChannelMonitor: {}", e),
 ))
 }
 Ok(res)
 }
 Ok(outpoint_to_channelmonitor)
	}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

 // Check that the persisted channel data is empty before any channels are
 // open.
 let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 0);
 let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 1);
 for mon in persisted_chan_data_0.values() {
 for (_, mon) in persisted_chan_data_0.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().len(), 1);
 for mon in persisted_chan_data_1.values() {
 for (_, mon) in persisted_chan_data_1.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 9, 2021
 Merged


persister: Expose method to read ChannelMonitors from disk
#863
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


108 changes: 62 additions & 46 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
	lightning::util::ser::ReadableArgs,
	bitcoin::{BlockHash, Txid},
	bitcoin::hashes::hex::FromHex,
	std::collections::HashMap,
	std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
 util::write_to_file(path, "manager".to_string(), manager)
	}

	#[cfg(test)]
	fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
 Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
 if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized
	{
 let path = self.path_to_monitor_data();
 if !Path::new(&path).exists() {
 return Ok(HashMap::new());
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.
@TheBlueMattTheBlueMattApr 7, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).
 }
 let mut outpoint_to_channelmonitor = HashMap::new();
 for file_option in fs::read_dir(path).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid ChannelMonitor file name",
 ));
 }
 let mut res = HashMap::new();
 for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }

 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

 let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
 if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx ID in filename",
 ));
 }

 let contents = fs::read(&file.path());
 if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let index = filename.unwrap().split_at(65).1.parse();
 if index.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx index in filename",
 ));
 }

 if let Ok((_, loaded_monitor)) =
 <(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
 res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
 } else {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }
 let contents = fs::read(&file.path())?;
 let mut buffer = Cursor::new(&contents);
 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
 Ok((blockhash, channel_monitor)) => {
 outpoint_to_channelmonitor.insert(
 OutPoint { txid: txid.unwrap(), index: index.unwrap() },
 (blockhash, channel_monitor),
 );
 }
 Err(e) => return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 format!("Failed to deserialize ChannelMonitor: {}", e),
 ))
 }
 Ok(res)
 }
 Ok(outpoint_to_channelmonitor)
	}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

 // Check that the persisted channel data is empty before any channels are
 // open.
 let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 0);
 let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 1);
 for mon in persisted_chan_data_0.values() {
 for (_, mon) in persisted_chan_data_0.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().len(), 1);
 for mon in persisted_chan_data_1.values() {
 for (_, mon) in persisted_chan_data_1.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 9, 2021
 Merged


persister: Expose method to read ChannelMonitors from disk
#863
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


108 changes: 62 additions & 46 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
	lightning::util::ser::ReadableArgs,
	bitcoin::{BlockHash, Txid},
	bitcoin::hashes::hex::FromHex,
	std::collections::HashMap,
	std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
 util::write_to_file(path, "manager".to_string(), manager)
	}

	#[cfg(test)]
	fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
 Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
 if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized
	{
 let path = self.path_to_monitor_data();
 if !Path::new(&path).exists() {
 return Ok(HashMap::new());
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.
@TheBlueMattTheBlueMattApr 7, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).
 }
 let mut outpoint_to_channelmonitor = HashMap::new();
 for file_option in fs::read_dir(path).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid ChannelMonitor file name",
 ));
 }
 let mut res = HashMap::new();
 for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }

 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

 let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
 if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx ID in filename",
 ));
 }

 let contents = fs::read(&file.path());
 if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let index = filename.unwrap().split_at(65).1.parse();
 if index.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx index in filename",
 ));
 }

 if let Ok((_, loaded_monitor)) =
 <(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
 res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
 } else {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }
 let contents = fs::read(&file.path())?;
 let mut buffer = Cursor::new(&contents);
 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
 Ok((blockhash, channel_monitor)) => {
 outpoint_to_channelmonitor.insert(
 OutPoint { txid: txid.unwrap(), index: index.unwrap() },
 (blockhash, channel_monitor),
 );
 }
 Err(e) => return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 format!("Failed to deserialize ChannelMonitor: {}", e),
 ))
 }
 Ok(res)
 }
 Ok(outpoint_to_channelmonitor)
	}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

 // Check that the persisted channel data is empty before any channels are
 // open.
 let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 0);
 let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 1);
 for mon in persisted_chan_data_0.values() {
 for (_, mon) in persisted_chan_data_0.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().len(), 1);
 for mon in persisted_chan_data_1.values() {
 for (_, mon) in persisted_chan_data_1.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 9, 2021
 Merged


persister: Expose method to read ChannelMonitors from disk
#863
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


108 changes: 62 additions & 46 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
	lightning::util::ser::ReadableArgs,
	bitcoin::{BlockHash, Txid},
	bitcoin::hashes::hex::FromHex,
	std::collections::HashMap,
	std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
 util::write_to_file(path, "manager".to_string(), manager)
	}

	#[cfg(test)]
	fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
 Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
 if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized
	{
 let path = self.path_to_monitor_data();
 if !Path::new(&path).exists() {
 return Ok(HashMap::new());
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.
@TheBlueMattTheBlueMattApr 7, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).
 }
 let mut outpoint_to_channelmonitor = HashMap::new();
 for file_option in fs::read_dir(path).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid ChannelMonitor file name",
 ));
 }
 let mut res = HashMap::new();
 for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }

 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

 let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
 if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx ID in filename",
 ));
 }

 let contents = fs::read(&file.path());
 if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let index = filename.unwrap().split_at(65).1.parse();
 if index.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx index in filename",
 ));
 }

 if let Ok((_, loaded_monitor)) =
 <(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
 res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
 } else {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }
 let contents = fs::read(&file.path())?;
 let mut buffer = Cursor::new(&contents);
 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
 Ok((blockhash, channel_monitor)) => {
 outpoint_to_channelmonitor.insert(
 OutPoint { txid: txid.unwrap(), index: index.unwrap() },
 (blockhash, channel_monitor),
 );
 }
 Err(e) => return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 format!("Failed to deserialize ChannelMonitor: {}", e),
 ))
 }
 Ok(res)
 }
 Ok(outpoint_to_channelmonitor)
	}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

 // Check that the persisted channel data is empty before any channels are
 // open.
 let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 0);
 let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 1);
 for mon in persisted_chan_data_0.values() {
 for (_, mon) in persisted_chan_data_0.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().len(), 1);
 for mon in persisted_chan_data_1.values() {
 for (_, mon) in persisted_chan_data_1.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 9, 2021
 Merged


persister: Expose method to read ChannelMonitors from disk
#863
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


108 changes: 62 additions & 46 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
	lightning::util::ser::ReadableArgs,
	bitcoin::{BlockHash, Txid},
	bitcoin::hashes::hex::FromHex,
	std::collections::HashMap,
	std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
 util::write_to_file(path, "manager".to_string(), manager)
	}

	#[cfg(test)]
	fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
 Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
 if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized
	{
 let path = self.path_to_monitor_data();
 if !Path::new(&path).exists() {
 return Ok(HashMap::new());
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.
@TheBlueMattTheBlueMattApr 7, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).
 }
 let mut outpoint_to_channelmonitor = HashMap::new();
 for file_option in fs::read_dir(path).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid ChannelMonitor file name",
 ));
 }
 let mut res = HashMap::new();
 for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }

 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

 let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
 if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx ID in filename",
 ));
 }

 let contents = fs::read(&file.path());
 if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let index = filename.unwrap().split_at(65).1.parse();
 if index.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx index in filename",
 ));
 }

 if let Ok((_, loaded_monitor)) =
 <(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
 res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
 } else {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }
 let contents = fs::read(&file.path())?;
 let mut buffer = Cursor::new(&contents);
 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
 Ok((blockhash, channel_monitor)) => {
 outpoint_to_channelmonitor.insert(
 OutPoint { txid: txid.unwrap(), index: index.unwrap() },
 (blockhash, channel_monitor),
 );
 }
 Err(e) => return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 format!("Failed to deserialize ChannelMonitor: {}", e),
 ))
 }
 Ok(res)
 }
 Ok(outpoint_to_channelmonitor)
	}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

 // Check that the persisted channel data is empty before any channels are
 // open.
 let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 0);
 let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 1);
 for mon in persisted_chan_data_0.values() {
 for (_, mon) in persisted_chan_data_0.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().len(), 1);
 for mon in persisted_chan_data_1.values() {
 for (_, mon) in persisted_chan_data_1.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
persister: Expose method to read ChannelMonitors from disk#863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 1 commit into

from

Apr 9, 2021
 Merged


persister: Expose method to read ChannelMonitors from disk
#863
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


108 changes: 62 additions & 46 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,8 @@ extern crate lightning;
extern crate bitcoin;
extern crate libc;

use bitcoin::hashes::hex::ToHex;
use bitcoin::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
Expand All@@ -22,21 +23,14 @@ use lightning::chain::keysinterface::{Sign, KeysInterface};
use lightning::chain::transaction::OutPoint;
use lightning::ln::channelmanager::ChannelManager;
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::ser::{ReadableArgs, Writeable};
use std::collections::HashMap;
use std::fs;
use std::io::Error;
use std::path::PathBuf;
use std::io::{Cursor, Error};
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::sync::Arc;

#[cfg(test)]
use {
	lightning::util::ser::ReadableArgs,
	bitcoin::{BlockHash, Txid},
	bitcoin::hashes::hex::FromHex,
	std::collections::HashMap,
	std::io::Cursor
};

/// FilesystemPersister persists channel data on disk, where each channel's
/// data is stored in a file named after its funding outpoint.
///
Expand DownExpand Up@@ -108,39 +102,61 @@ impl FilesystemPersister {
 util::write_to_file(path, "manager".to_string(), manager)
	}

	#[cfg(test)]
	fn load_channel_data<Keys: KeysInterface>(&self, keys: &Keys) ->
 Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> {
 if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<HashMap<OutPoint, (BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized
	{
 let path = self.path_to_monitor_data();
 if !Path::new(&path).exists() {
 return Ok(HashMap::new());
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a NotFound error? That way caller's can create the directory if it does not exist.
@TheBlueMattTheBlueMattApr 7, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, isn't it more likely its just the first startup and thus there's no monitors?
@jkczyzjkczyzApr 7, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that the caller would handle creating the directory. But I guess that FilesystemPersister creates it on demand, so probably ok then. Wasn't sure if we want to give the user insight into this (e.g., they instantiate a persister expecting to find data but don't because the path was wrong).
 }
 let mut outpoint_to_channelmonitor = HashMap::new();
 for file_option in fs::read_dir(path).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid ChannelMonitor file name",
 ));
 }
 let mut res = HashMap::new();
 for file_option in fs::read_dir(self.path_to_monitor_data()).unwrap() {
 let file = file_option.unwrap();
 let owned_file_name = file.file_name();
 let filename = owned_file_name.to_str();
 if !filename.is_some() || !filename.unwrap().is_ascii() || filename.unwrap().len() < 65 {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }

 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }

 let index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse();
 if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let txid = Txid::from_hex(filename.unwrap().split_at(64).0);
 if txid.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx ID in filename",
 ));
 }

 let contents = fs::read(&file.path());
 if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); }
 let index = filename.unwrap().split_at(65).1.parse();
 if index.is_err() {
 return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 "Invalid tx index in filename",
 ));
 }

 if let Ok((_, loaded_monitor)) =
 <(BlockHash, ChannelMonitor<Keys::Signer>)>::read(&mut Cursor::new(&contents.unwrap()), keys) {
 res.insert(OutPoint { txid: txid.unwrap(), index: index.unwrap() }, loaded_monitor);
 } else {
 return Err(ChannelMonitorUpdateErr::PermanentFailure);
 }
 let contents = fs::read(&file.path())?;
 let mut buffer = Cursor::new(&contents);
 match <(BlockHash, ChannelMonitor<Signer>)>::read(&mut buffer, &*keys_manager) {
 Ok((blockhash, channel_monitor)) => {
 outpoint_to_channelmonitor.insert(
 OutPoint { txid: txid.unwrap(), index: index.unwrap() },
 (blockhash, channel_monitor),
 );
 }
 Err(e) => return Err(std::io::Error::new(
 std::io::ErrorKind::InvalidData,
 format!("Failed to deserialize ChannelMonitor: {}", e),
 ))
 }
 Ok(res)
 }
 Ok(outpoint_to_channelmonitor)
	}
}

impl<ChannelSigner: Sign + Send + Sync> channelmonitor::Persist<ChannelSigner> for FilesystemPersister {
Expand DownExpand Up@@ -210,22 +226,22 @@ mod tests {

 // Check that the persisted channel data is empty before any channels are
 // open.
 let mut persisted_chan_data_0 = persister_0.load_channel_data(nodes[0].keys_manager).unwrap();
 let mut persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 0);
 let mut persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 let mut persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().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.load_channel_data(nodes[0].keys_manager).unwrap();
 persisted_chan_data_0 = persister_0.read_channelmonitors(nodes[0].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_0.keys().len(), 1);
 for mon in persisted_chan_data_0.values() {
 for (_, mon) in persisted_chan_data_0.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 persisted_chan_data_1 = persister_1.load_channel_data(nodes[1].keys_manager).unwrap();
 persisted_chan_data_1 = persister_1.read_channelmonitors(nodes[1].keys_manager).unwrap();
 assert_eq!(persisted_chan_data_1.keys().len(), 1);
 for mon in persisted_chan_data_1.values() {
 for (_, mon) in persisted_chan_data_1.values() {
 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
 }
 }
Expand Down