persist: Persist ChannelMonitors in their own directory. #806
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheBlueMatt
reviewed
Feb 26, 2021
Codecov Report
@@ Coverage Diff @@
## main #806 +/- ##
==========================================
- Coverage 91.04% 91.00% -0.05%
==========================================
Files 48 48
Lines 25480 25483 +3
==========================================
- Hits 23199 23190 -9
- Misses 2281 2293 +12
Continue to review full report at Codecov.
|
valentinewallace
force-pushed
the
monitor-data-persistence-path
branch
from
7be8bbf to
bfaec71
Compare
TheBlueMatt
approved these changes
Feb 28, 2021
jkczyz
reviewed
Feb 28, 2021
There was a problem hiding this comment.
Post-merge ACK.
Code Review ACK bfaec71
Could be cool to display somewhere in the doc what's the expected dir-tree should look like (e.g a
treecmd-like output)your_path └── channel ├── manager └── monitors
I think it's actually suppose to be:
your_path
├── manager
└── monitors
└── channel
But currently this is not enforced because FilesystemPersister::persist_manager can be given any directory by the user. We could enforce this by making it non-pub and have a pub method return a closure calling it with the appropriate path.
Comment on lines
104
to
135
| Result<HashMap<OutPoint, ChannelMonitor<Keys::Signer>>, ChannelMonitorUpdateErr> { | ||
| if let Err(_) = fs::create_dir_all(&self.path_to_channel_data) { | ||
| return Err(ChannelMonitorUpdateErr::PermanentFailure); | ||
| } | ||
| let mut res = HashMap::new(); | ||
| for file_option in fs::read_dir(&self.path_to_channel_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 { | ||
| if let Err(_) = fs::create_dir_all(self.path_to_monitor_data()) { | ||
| return Err(ChannelMonitorUpdateErr::PermanentFailure); | ||
| } | ||
| 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 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 index = filename.unwrap().split_at(65).1.split('.').next().unwrap().parse(); | ||
| if index.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); } | ||
|
|
||
| let contents = fs::read(&file.path()); | ||
| if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); } | ||
| let contents = fs::read(&file.path()); | ||
| if contents.is_err() { return Err(ChannelMonitorUpdateErr::PermanentFailure); } | ||
|
|
||
| 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); | ||
| 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); | ||
| } | ||
| } | ||
| Ok(res) | ||
| } | ||
| Ok(res) | ||
| } | ||
| } |
There was a problem hiding this comment.
Indentation looks off by one. I've started following these conventions when wrapping long method signatures:
https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/items.md
With an extra line for the opening brace, you can reduce the indent to how it was before.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Slightly nicer to work with for loading monitors from disk.