add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
Merged

add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion lightning-background-processor/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }
82 changes: 34 additions & 48 deletions lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
M::Target: 'static + chain::Watch<Signer>,
T::Target: 'static + BroadcasterInterface,
K::Target: 'static + KeysInterface<Signer = Signer>,
F::Target: 'static + FeeEstimator,
L::Target: 'static + Logger,
{
/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
/// (which will cause the [`BackgroundProcessor`] which called this method to exit).

@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.

@johncantrell97johncantrell97Apr 12, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

hm the BP docs already also have this:

/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or
/// uploading to one or more backup services. See [ChannelManager::write] for writing out a
/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's
/// provided implementation.

could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.

fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
///
/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
/// provided implementation.
///
/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
/// for Rust-Lightning's provided implementation.
/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
/// for LDK's provided implementation.
///
/// Typically, users should either implement [`Persister::persist_manager`] to never return an
/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
/// [`stop`]: Self::stop
/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
CMH: 'static + Deref + Send + Sync,
RMH: 'static + Deref + Send + Sync,
EH: 'static + EventHandler + Send,
PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
PS: 'static + Deref + Send,
M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
CMH::Target: 'static + ChannelMessageHandler,
RMH::Target: 'static + RoutingMessageHandler,
UMH::Target: 'static + CustomMessageHandler,
PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
{
let stop_thread = Arc::new(AtomicBool::new(false));
let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
use lightning::util::logger::Logger;
use lightning::util::ser::Writeable;
use lightning::util::test_utils;
use lightning::util::persist::KVStorePersister;
use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
use lightning_invoice::utils::DefaultRouter;
use lightning_persister::FilesystemPersister;
use std::fs;
use std::fs::{self, File};
use std::ops::Deref;
use std::path::PathBuf;
use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
struct Persister {
data_dir: String,
graph_error: Option<(std::io::ErrorKind, &'static str)>,
manager_error: Option<(std::io::ErrorKind, &'static str)>
manager_error: Option<(std::io::ErrorKind, &'static str)>,
filesystem_persister: FilesystemPersister,
}

impl Persister {
fn new(data_dir: String) -> Self {
Self { data_dir, graph_error: None, manager_error: None }
let filesystem_persister = FilesystemPersister::new(data_dir.clone());
Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
}

fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
M::Target: 'static + chain::Watch<Signer>,
T::Target: 'static + BroadcasterInterface,
K::Target: 'static + KeysInterface<Signer = Signer>,
F::Target: 'static + FeeEstimator,
L::Target: 'static + Logger,
{
fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
match self.manager_error {
None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
Some((error, message)) => Err(std::io::Error::new(error, message)),
impl KVStorePersister for Persister {
fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
if key == "manager" {
if let Some((error, message)) = self.manager_error {
return Err(std::io::Error::new(error, message))
}
}
}

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
if key == "network_graph" {
if let Some((error, message)) = self.graph_error {
return Err(std::io::Error::new(error, message))
}
}

self.filesystem_persister.persist(key, object)
}
}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

// Initiate the background processors to watch each node.
let data_dir = nodes[0].persister.get_data_dir();
let persister = Persister::new(data_dir);
let persister = Arc::new(Persister::new(data_dir));
let event_handler = |_: &_| {};
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
// `FRESHNESS_TIMER`.
let nodes = create_nodes(1, "test_timer_tick_called".to_string());
let data_dir = nodes[0].persister.get_data_dir();
let persister = Persister::new(data_dir);
let persister = Arc::new(Persister::new(data_dir));
let event_handler = |_: &_| {};
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
open_channel!(nodes[0], nodes[1], 100000);

let data_dir = nodes[0].persister.get_data_dir();
let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
let event_handler = |_: &_| {};
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
// Test that if we encounter an error during network graph persistence, an error gets returned.
let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
let data_dir = nodes[0].persister.get_data_dir();
let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
let event_handler = |_: &_| {};
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
let channel_value = 100000;
let data_dir = nodes[0].persister.get_data_dir();
let persister = Persister::new(data_dir.clone());
let persister = Arc::new(Persister::new(data_dir.clone()));

// Set up a background event handler for FundingGenerationReady events.
let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
// Set up a background event handler for SpendableOutputs events.
let (sender, receiver) = std::sync::mpsc::sync_channel(1);
let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
let persister = Arc::new(Persister::new(data_dir));
let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

// Force close the channel and check that the SpendableOutputs event was handled.
nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

// Initiate the background processors to watch each node.
let data_dir = nodes[0].persister.get_data_dir();
let persister = Persister::new(data_dir);
let persister = Arc::new(Persister::new(data_dir));
let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down
94 changes: 11 additions & 83 deletions lightning-persister/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
self.write(writer)
}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
M::Target: chain::Watch<Signer>,
T::Target: BroadcasterInterface,
K::Target: KeysInterface<Signer=Signer>,
F::Target: FeeEstimator,
L::Target: Logger,
{
fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
self.write(writer)
}
}

impl DiskWriteable for NetworkGraph {
fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
self.write(writer)
}
}

impl FilesystemPersister {
/// Initialize a new FilesystemPersister and set the path to the individual channels'
/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
self.path_to_channel_data.clone()
}

pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
let mut path = PathBuf::from(self.path_to_channel_data.clone());
path.push("monitors");
path
}

/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
/// initialization, within a file called "manager".
pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
data_dir: String,
manager: &ChannelManager<Signer, M, T, K, F, L>
) -> Result<(), std::io::Error>
where
M::Target: chain::Watch<Signer>,
T::Target: BroadcasterInterface,
K::Target: KeysInterface<Signer=Signer>,
F::Target: FeeEstimator,
L::Target: Logger,
{
let path = PathBuf::from(data_dir);
util::write_to_file(path, "manager".to_string(), manager)
}

/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
/// initialization, within a file called "network_graph"
pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
let path = PathBuf::from(data_dir);
util::write_to_file(path, "network_graph".to_string(), network_graph)
}

/// Read `ChannelMonitor`s from disk.
pub fn read_channelmonitors<Signer: Sign, K: Deref> (
&self, keys_manager: K
) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
where K::Target: KeysInterface<Signer=Signer> + Sized,
{
let path = self.path_to_monitor_data();
let mut path = PathBuf::from(&self.path_to_channel_data);
path.push("monitors");
if !Path::new(&path).exists() {
return Ok(Vec::new());
}
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
// TODO: We really need a way for the persister to inform the user that its time to crash/shut
// down once these start returning failure.
// A PermanentFailure implies we need to shut down since we're force-closing channels without
// even broadcasting!

fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
util::write_to_file(self.path_to_monitor_data(), filename, monitor)
.map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
}

fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
util::write_to_file(self.path_to_monitor_data(), filename, monitor)
.map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);
Comment on lines +124 to +125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?

@johncantrell97johncantrell97Apr 20, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Like this?

let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

util::write_to_file(dest_file, object)
}
}

Expand Down
Loading
, '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
add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
 Merged


add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417
Show file tree
Hide file tree
 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


2 changes: 1 addition & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

82 changes: 34 additions & 48 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
	M::Target: 'static + chain::Watch<Signer>,
	T::Target: 'static + BroadcasterInterface,
	K::Target: 'static + KeysInterface<Signer = Signer>,
	F::Target: 'static + FeeEstimator,
	L::Target: 'static + Logger,
{
	/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
	/// (which will cause the [`BackgroundProcessor`] which called this method to exit).
@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.
@johncantrell97johncantrell97Apr 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

hm the BP docs already also have this:
/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or

/// uploading to one or more backup services. See [ChannelManager::write] for writing out a

/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's

/// provided implementation.
could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.
	fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

	/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
	fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
	///
	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
	/// provided implementation.
	///
	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
	/// for Rust-Lightning's provided implementation.
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
	/// for LDK's provided implementation.
	///
	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
	/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
	/// [`stop`]: Self::stop
	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
	/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
	/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
	/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
	pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
 CMH: 'static + Deref + Send + Sync,
 RMH: 'static + Deref + Send + Sync,
 EH: 'static + EventHandler + Send,
 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
 PS: 'static + Deref + Send,
 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
 CMH::Target: 'static + ChannelMessageHandler,
 RMH::Target: 'static + RoutingMessageHandler,
 UMH::Target: 'static + CustomMessageHandler,
 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
	{
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
	use lightning::util::logger::Logger;
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::fs::{self, File};
	use std::ops::Deref;
	use std::path::PathBuf;
	use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
	struct Persister {
 data_dir: String,
 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 manager_error: Option<(std::io::ErrorKind, &'static str)>
 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 filesystem_persister: FilesystemPersister,
	}

	impl Persister {
 fn new(data_dir: String) -> Self {
 Self { data_dir, graph_error: None, manager_error: None }
 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
 Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
 }

 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
 }
	}

	impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
 M::Target: 'static + chain::Watch<Signer>,
 T::Target: 'static + BroadcasterInterface,
 K::Target: 'static + KeysInterface<Signer = Signer>,
 F::Target: 'static + FeeEstimator,
 L::Target: 'static + Logger,
	{
 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
 match self.manager_error {
 None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
 Some((error, message)) => Err(std::io::Error::new(error, message)),
	impl KVStorePersister for Persister {
 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 if key == "manager" {
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message))
 }
 }
 }

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
	if key == "network_graph" {
	if let Some((error, message)) = self.graph_error {
	return Err(std::io::Error::new(error, message))
}
 }

 self.filesystem_persister.persist(key, object)
 }
	}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
 // `FRESHNESS_TIMER`.
 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
 open_channel!(nodes[0], nodes[1], 100000);

 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
 // Test that if we encounter an error during network graph persistence, an error gets returned.
 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 let channel_value = 100000;
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir.clone());
 let persister = Arc::new(Persister::new(data_dir.clone()));

 // Set up a background event handler for FundingGenerationReady events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
 // Set up a background event handler for SpendableOutputs events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
 let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 let persister = Arc::new(Persister::new(data_dir));
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down

94 changes: 11 additions & 83 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
	path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
 self.write(writer)
	}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
	M::Target: chain::Watch<Signer>,
	T::Target: BroadcasterInterface,
	K::Target: KeysInterface<Signer=Signer>,
	F::Target: FeeEstimator,
	L::Target: Logger,
{
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl DiskWriteable for NetworkGraph {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl FilesystemPersister {
	/// Initialize a new FilesystemPersister and set the path to the individual channels'
	/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
 self.path_to_channel_data.clone()
	}

	pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
 let mut path = PathBuf::from(self.path_to_channel_data.clone());
 path.push("monitors");
 path
	}

	/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "manager".
	pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 data_dir: String,
 manager: &ChannelManager<Signer, M, T, K, F, L>
	) -> Result<(), std::io::Error>
	where
 M::Target: chain::Watch<Signer>,
 T::Target: BroadcasterInterface,
 K::Target: KeysInterface<Signer=Signer>,
 F::Target: FeeEstimator,
 L::Target: Logger,
	{
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "manager".to_string(), manager)
	}

	/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "network_graph"
	pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "network_graph".to_string(), network_graph)
	}

	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized,
	{
 let path = self.path_to_monitor_data();
 let mut path = PathBuf::from(&self.path_to_channel_data);
 path.push("monitors");
 if !Path::new(&path).exists() {
 return Ok(Vec::new());
 }
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
	}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
	// TODO: We really need a way for the persister to inform the user that its time to crash/shut
	// down once these start returning failure.
	// A PermanentFailure implies we need to shut down since we're force-closing channels without
	// even broadcasting!

	fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
	}

	fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);

Comment on lines

+124
 to 
+125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?
@johncantrell97johncantrell97Apr 20, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Like this?
let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

 util::write_to_file(dest_file, object)
	}
}

Expand Down
Loading

, '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
add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
 Merged


add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417
Show file tree
Hide file tree
 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


2 changes: 1 addition & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

82 changes: 34 additions & 48 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
	M::Target: 'static + chain::Watch<Signer>,
	T::Target: 'static + BroadcasterInterface,
	K::Target: 'static + KeysInterface<Signer = Signer>,
	F::Target: 'static + FeeEstimator,
	L::Target: 'static + Logger,
{
	/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
	/// (which will cause the [`BackgroundProcessor`] which called this method to exit).
@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.
@johncantrell97johncantrell97Apr 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

hm the BP docs already also have this:
/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or

/// uploading to one or more backup services. See [ChannelManager::write] for writing out a

/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's

/// provided implementation.
could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.
	fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

	/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
	fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
	///
	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
	/// provided implementation.
	///
	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
	/// for Rust-Lightning's provided implementation.
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
	/// for LDK's provided implementation.
	///
	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
	/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
	/// [`stop`]: Self::stop
	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
	/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
	/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
	/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
	pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
 CMH: 'static + Deref + Send + Sync,
 RMH: 'static + Deref + Send + Sync,
 EH: 'static + EventHandler + Send,
 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
 PS: 'static + Deref + Send,
 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
 CMH::Target: 'static + ChannelMessageHandler,
 RMH::Target: 'static + RoutingMessageHandler,
 UMH::Target: 'static + CustomMessageHandler,
 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
	{
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
	use lightning::util::logger::Logger;
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::fs::{self, File};
	use std::ops::Deref;
	use std::path::PathBuf;
	use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
	struct Persister {
 data_dir: String,
 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 manager_error: Option<(std::io::ErrorKind, &'static str)>
 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 filesystem_persister: FilesystemPersister,
	}

	impl Persister {
 fn new(data_dir: String) -> Self {
 Self { data_dir, graph_error: None, manager_error: None }
 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
 Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
 }

 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
 }
	}

	impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
 M::Target: 'static + chain::Watch<Signer>,
 T::Target: 'static + BroadcasterInterface,
 K::Target: 'static + KeysInterface<Signer = Signer>,
 F::Target: 'static + FeeEstimator,
 L::Target: 'static + Logger,
	{
 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
 match self.manager_error {
 None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
 Some((error, message)) => Err(std::io::Error::new(error, message)),
	impl KVStorePersister for Persister {
 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 if key == "manager" {
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message))
 }
 }
 }

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
	if key == "network_graph" {
	if let Some((error, message)) = self.graph_error {
	return Err(std::io::Error::new(error, message))
}
 }

 self.filesystem_persister.persist(key, object)
 }
	}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
 // `FRESHNESS_TIMER`.
 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
 open_channel!(nodes[0], nodes[1], 100000);

 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
 // Test that if we encounter an error during network graph persistence, an error gets returned.
 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 let channel_value = 100000;
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir.clone());
 let persister = Arc::new(Persister::new(data_dir.clone()));

 // Set up a background event handler for FundingGenerationReady events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
 // Set up a background event handler for SpendableOutputs events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
 let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 let persister = Arc::new(Persister::new(data_dir));
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down

94 changes: 11 additions & 83 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
	path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
 self.write(writer)
	}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
	M::Target: chain::Watch<Signer>,
	T::Target: BroadcasterInterface,
	K::Target: KeysInterface<Signer=Signer>,
	F::Target: FeeEstimator,
	L::Target: Logger,
{
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl DiskWriteable for NetworkGraph {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl FilesystemPersister {
	/// Initialize a new FilesystemPersister and set the path to the individual channels'
	/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
 self.path_to_channel_data.clone()
	}

	pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
 let mut path = PathBuf::from(self.path_to_channel_data.clone());
 path.push("monitors");
 path
	}

	/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "manager".
	pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 data_dir: String,
 manager: &ChannelManager<Signer, M, T, K, F, L>
	) -> Result<(), std::io::Error>
	where
 M::Target: chain::Watch<Signer>,
 T::Target: BroadcasterInterface,
 K::Target: KeysInterface<Signer=Signer>,
 F::Target: FeeEstimator,
 L::Target: Logger,
	{
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "manager".to_string(), manager)
	}

	/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "network_graph"
	pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "network_graph".to_string(), network_graph)
	}

	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized,
	{
 let path = self.path_to_monitor_data();
 let mut path = PathBuf::from(&self.path_to_channel_data);
 path.push("monitors");
 if !Path::new(&path).exists() {
 return Ok(Vec::new());
 }
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
	}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
	// TODO: We really need a way for the persister to inform the user that its time to crash/shut
	// down once these start returning failure.
	// A PermanentFailure implies we need to shut down since we're force-closing channels without
	// even broadcasting!

	fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
	}

	fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);

Comment on lines

+124
 to 
+125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?
@johncantrell97johncantrell97Apr 20, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Like this?
let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

 util::write_to_file(dest_file, object)
	}
}

Expand Down
Loading

, '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
add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
 Merged


add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417
Show file tree
Hide file tree
 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


2 changes: 1 addition & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

82 changes: 34 additions & 48 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
	M::Target: 'static + chain::Watch<Signer>,
	T::Target: 'static + BroadcasterInterface,
	K::Target: 'static + KeysInterface<Signer = Signer>,
	F::Target: 'static + FeeEstimator,
	L::Target: 'static + Logger,
{
	/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
	/// (which will cause the [`BackgroundProcessor`] which called this method to exit).
@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.
@johncantrell97johncantrell97Apr 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

hm the BP docs already also have this:
/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or

/// uploading to one or more backup services. See [ChannelManager::write] for writing out a

/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's

/// provided implementation.
could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.
	fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

	/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
	fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
	///
	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
	/// provided implementation.
	///
	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
	/// for Rust-Lightning's provided implementation.
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
	/// for LDK's provided implementation.
	///
	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
	/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
	/// [`stop`]: Self::stop
	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
	/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
	/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
	/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
	pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
 CMH: 'static + Deref + Send + Sync,
 RMH: 'static + Deref + Send + Sync,
 EH: 'static + EventHandler + Send,
 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
 PS: 'static + Deref + Send,
 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
 CMH::Target: 'static + ChannelMessageHandler,
 RMH::Target: 'static + RoutingMessageHandler,
 UMH::Target: 'static + CustomMessageHandler,
 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
	{
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
	use lightning::util::logger::Logger;
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::fs::{self, File};
	use std::ops::Deref;
	use std::path::PathBuf;
	use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
	struct Persister {
 data_dir: String,
 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 manager_error: Option<(std::io::ErrorKind, &'static str)>
 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 filesystem_persister: FilesystemPersister,
	}

	impl Persister {
 fn new(data_dir: String) -> Self {
 Self { data_dir, graph_error: None, manager_error: None }
 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
 Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
 }

 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
 }
	}

	impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
 M::Target: 'static + chain::Watch<Signer>,
 T::Target: 'static + BroadcasterInterface,
 K::Target: 'static + KeysInterface<Signer = Signer>,
 F::Target: 'static + FeeEstimator,
 L::Target: 'static + Logger,
	{
 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
 match self.manager_error {
 None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
 Some((error, message)) => Err(std::io::Error::new(error, message)),
	impl KVStorePersister for Persister {
 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 if key == "manager" {
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message))
 }
 }
 }

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
	if key == "network_graph" {
	if let Some((error, message)) = self.graph_error {
	return Err(std::io::Error::new(error, message))
}
 }

 self.filesystem_persister.persist(key, object)
 }
	}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
 // `FRESHNESS_TIMER`.
 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
 open_channel!(nodes[0], nodes[1], 100000);

 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
 // Test that if we encounter an error during network graph persistence, an error gets returned.
 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 let channel_value = 100000;
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir.clone());
 let persister = Arc::new(Persister::new(data_dir.clone()));

 // Set up a background event handler for FundingGenerationReady events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
 // Set up a background event handler for SpendableOutputs events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
 let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 let persister = Arc::new(Persister::new(data_dir));
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down

94 changes: 11 additions & 83 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
	path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
 self.write(writer)
	}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
	M::Target: chain::Watch<Signer>,
	T::Target: BroadcasterInterface,
	K::Target: KeysInterface<Signer=Signer>,
	F::Target: FeeEstimator,
	L::Target: Logger,
{
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl DiskWriteable for NetworkGraph {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl FilesystemPersister {
	/// Initialize a new FilesystemPersister and set the path to the individual channels'
	/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
 self.path_to_channel_data.clone()
	}

	pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
 let mut path = PathBuf::from(self.path_to_channel_data.clone());
 path.push("monitors");
 path
	}

	/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "manager".
	pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 data_dir: String,
 manager: &ChannelManager<Signer, M, T, K, F, L>
	) -> Result<(), std::io::Error>
	where
 M::Target: chain::Watch<Signer>,
 T::Target: BroadcasterInterface,
 K::Target: KeysInterface<Signer=Signer>,
 F::Target: FeeEstimator,
 L::Target: Logger,
	{
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "manager".to_string(), manager)
	}

	/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "network_graph"
	pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "network_graph".to_string(), network_graph)
	}

	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized,
	{
 let path = self.path_to_monitor_data();
 let mut path = PathBuf::from(&self.path_to_channel_data);
 path.push("monitors");
 if !Path::new(&path).exists() {
 return Ok(Vec::new());
 }
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
	}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
	// TODO: We really need a way for the persister to inform the user that its time to crash/shut
	// down once these start returning failure.
	// A PermanentFailure implies we need to shut down since we're force-closing channels without
	// even broadcasting!

	fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
	}

	fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);

Comment on lines

+124
 to 
+125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?
@johncantrell97johncantrell97Apr 20, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Like this?
let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

 util::write_to_file(dest_file, object)
	}
}

Expand Down
Loading

, '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
add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
 Merged


add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417
Show file tree
Hide file tree
 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


2 changes: 1 addition & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

82 changes: 34 additions & 48 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
	M::Target: 'static + chain::Watch<Signer>,
	T::Target: 'static + BroadcasterInterface,
	K::Target: 'static + KeysInterface<Signer = Signer>,
	F::Target: 'static + FeeEstimator,
	L::Target: 'static + Logger,
{
	/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
	/// (which will cause the [`BackgroundProcessor`] which called this method to exit).
@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.
@johncantrell97johncantrell97Apr 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

hm the BP docs already also have this:
/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or

/// uploading to one or more backup services. See [ChannelManager::write] for writing out a

/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's

/// provided implementation.
could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.
	fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

	/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
	fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
	///
	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
	/// provided implementation.
	///
	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
	/// for Rust-Lightning's provided implementation.
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
	/// for LDK's provided implementation.
	///
	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
	/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
	/// [`stop`]: Self::stop
	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
	/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
	/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
	/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
	pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
 CMH: 'static + Deref + Send + Sync,
 RMH: 'static + Deref + Send + Sync,
 EH: 'static + EventHandler + Send,
 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
 PS: 'static + Deref + Send,
 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
 CMH::Target: 'static + ChannelMessageHandler,
 RMH::Target: 'static + RoutingMessageHandler,
 UMH::Target: 'static + CustomMessageHandler,
 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
	{
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
	use lightning::util::logger::Logger;
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::fs::{self, File};
	use std::ops::Deref;
	use std::path::PathBuf;
	use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
	struct Persister {
 data_dir: String,
 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 manager_error: Option<(std::io::ErrorKind, &'static str)>
 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 filesystem_persister: FilesystemPersister,
	}

	impl Persister {
 fn new(data_dir: String) -> Self {
 Self { data_dir, graph_error: None, manager_error: None }
 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
 Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
 }

 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
 }
	}

	impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
 M::Target: 'static + chain::Watch<Signer>,
 T::Target: 'static + BroadcasterInterface,
 K::Target: 'static + KeysInterface<Signer = Signer>,
 F::Target: 'static + FeeEstimator,
 L::Target: 'static + Logger,
	{
 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
 match self.manager_error {
 None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
 Some((error, message)) => Err(std::io::Error::new(error, message)),
	impl KVStorePersister for Persister {
 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 if key == "manager" {
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message))
 }
 }
 }

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
	if key == "network_graph" {
	if let Some((error, message)) = self.graph_error {
	return Err(std::io::Error::new(error, message))
}
 }

 self.filesystem_persister.persist(key, object)
 }
	}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
 // `FRESHNESS_TIMER`.
 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
 open_channel!(nodes[0], nodes[1], 100000);

 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
 // Test that if we encounter an error during network graph persistence, an error gets returned.
 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 let channel_value = 100000;
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir.clone());
 let persister = Arc::new(Persister::new(data_dir.clone()));

 // Set up a background event handler for FundingGenerationReady events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
 // Set up a background event handler for SpendableOutputs events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
 let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 let persister = Arc::new(Persister::new(data_dir));
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down

94 changes: 11 additions & 83 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
	path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
 self.write(writer)
	}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
	M::Target: chain::Watch<Signer>,
	T::Target: BroadcasterInterface,
	K::Target: KeysInterface<Signer=Signer>,
	F::Target: FeeEstimator,
	L::Target: Logger,
{
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl DiskWriteable for NetworkGraph {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl FilesystemPersister {
	/// Initialize a new FilesystemPersister and set the path to the individual channels'
	/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
 self.path_to_channel_data.clone()
	}

	pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
 let mut path = PathBuf::from(self.path_to_channel_data.clone());
 path.push("monitors");
 path
	}

	/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "manager".
	pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 data_dir: String,
 manager: &ChannelManager<Signer, M, T, K, F, L>
	) -> Result<(), std::io::Error>
	where
 M::Target: chain::Watch<Signer>,
 T::Target: BroadcasterInterface,
 K::Target: KeysInterface<Signer=Signer>,
 F::Target: FeeEstimator,
 L::Target: Logger,
	{
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "manager".to_string(), manager)
	}

	/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "network_graph"
	pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "network_graph".to_string(), network_graph)
	}

	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized,
	{
 let path = self.path_to_monitor_data();
 let mut path = PathBuf::from(&self.path_to_channel_data);
 path.push("monitors");
 if !Path::new(&path).exists() {
 return Ok(Vec::new());
 }
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
	}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
	// TODO: We really need a way for the persister to inform the user that its time to crash/shut
	// down once these start returning failure.
	// A PermanentFailure implies we need to shut down since we're force-closing channels without
	// even broadcasting!

	fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
	}

	fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);

Comment on lines

+124
 to 
+125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?
@johncantrell97johncantrell97Apr 20, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Like this?
let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

 util::write_to_file(dest_file, object)
	}
}

Expand Down
Loading

, '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
add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
 Merged


add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417
Show file tree
Hide file tree
 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


2 changes: 1 addition & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

82 changes: 34 additions & 48 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
	M::Target: 'static + chain::Watch<Signer>,
	T::Target: 'static + BroadcasterInterface,
	K::Target: 'static + KeysInterface<Signer = Signer>,
	F::Target: 'static + FeeEstimator,
	L::Target: 'static + Logger,
{
	/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
	/// (which will cause the [`BackgroundProcessor`] which called this method to exit).
@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.
@johncantrell97johncantrell97Apr 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

hm the BP docs already also have this:
/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or

/// uploading to one or more backup services. See [ChannelManager::write] for writing out a

/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's

/// provided implementation.
could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.
	fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

	/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
	fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
	///
	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
	/// provided implementation.
	///
	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
	/// for Rust-Lightning's provided implementation.
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
	/// for LDK's provided implementation.
	///
	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
	/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
	/// [`stop`]: Self::stop
	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
	/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
	/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
	/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
	pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
 CMH: 'static + Deref + Send + Sync,
 RMH: 'static + Deref + Send + Sync,
 EH: 'static + EventHandler + Send,
 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
 PS: 'static + Deref + Send,
 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
 CMH::Target: 'static + ChannelMessageHandler,
 RMH::Target: 'static + RoutingMessageHandler,
 UMH::Target: 'static + CustomMessageHandler,
 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
	{
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
	use lightning::util::logger::Logger;
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::fs::{self, File};
	use std::ops::Deref;
	use std::path::PathBuf;
	use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
	struct Persister {
 data_dir: String,
 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 manager_error: Option<(std::io::ErrorKind, &'static str)>
 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 filesystem_persister: FilesystemPersister,
	}

	impl Persister {
 fn new(data_dir: String) -> Self {
 Self { data_dir, graph_error: None, manager_error: None }
 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
 Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
 }

 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
 }
	}

	impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
 M::Target: 'static + chain::Watch<Signer>,
 T::Target: 'static + BroadcasterInterface,
 K::Target: 'static + KeysInterface<Signer = Signer>,
 F::Target: 'static + FeeEstimator,
 L::Target: 'static + Logger,
	{
 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
 match self.manager_error {
 None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
 Some((error, message)) => Err(std::io::Error::new(error, message)),
	impl KVStorePersister for Persister {
 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 if key == "manager" {
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message))
 }
 }
 }

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
	if key == "network_graph" {
	if let Some((error, message)) = self.graph_error {
	return Err(std::io::Error::new(error, message))
}
 }

 self.filesystem_persister.persist(key, object)
 }
	}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
 // `FRESHNESS_TIMER`.
 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
 open_channel!(nodes[0], nodes[1], 100000);

 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
 // Test that if we encounter an error during network graph persistence, an error gets returned.
 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 let channel_value = 100000;
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir.clone());
 let persister = Arc::new(Persister::new(data_dir.clone()));

 // Set up a background event handler for FundingGenerationReady events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
 // Set up a background event handler for SpendableOutputs events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
 let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 let persister = Arc::new(Persister::new(data_dir));
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down

94 changes: 11 additions & 83 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
	path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
 self.write(writer)
	}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
	M::Target: chain::Watch<Signer>,
	T::Target: BroadcasterInterface,
	K::Target: KeysInterface<Signer=Signer>,
	F::Target: FeeEstimator,
	L::Target: Logger,
{
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl DiskWriteable for NetworkGraph {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl FilesystemPersister {
	/// Initialize a new FilesystemPersister and set the path to the individual channels'
	/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
 self.path_to_channel_data.clone()
	}

	pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
 let mut path = PathBuf::from(self.path_to_channel_data.clone());
 path.push("monitors");
 path
	}

	/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "manager".
	pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 data_dir: String,
 manager: &ChannelManager<Signer, M, T, K, F, L>
	) -> Result<(), std::io::Error>
	where
 M::Target: chain::Watch<Signer>,
 T::Target: BroadcasterInterface,
 K::Target: KeysInterface<Signer=Signer>,
 F::Target: FeeEstimator,
 L::Target: Logger,
	{
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "manager".to_string(), manager)
	}

	/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "network_graph"
	pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "network_graph".to_string(), network_graph)
	}

	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized,
	{
 let path = self.path_to_monitor_data();
 let mut path = PathBuf::from(&self.path_to_channel_data);
 path.push("monitors");
 if !Path::new(&path).exists() {
 return Ok(Vec::new());
 }
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
	}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
	// TODO: We really need a way for the persister to inform the user that its time to crash/shut
	// down once these start returning failure.
	// A PermanentFailure implies we need to shut down since we're force-closing channels without
	// even broadcasting!

	fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
	}

	fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);

Comment on lines

+124
 to 
+125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?
@johncantrell97johncantrell97Apr 20, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Like this?
let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

 util::write_to_file(dest_file, object)
	}
}

Expand Down
Loading

, '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
add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
 Merged


add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417
Show file tree
Hide file tree
 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


2 changes: 1 addition & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

82 changes: 34 additions & 48 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
	M::Target: 'static + chain::Watch<Signer>,
	T::Target: 'static + BroadcasterInterface,
	K::Target: 'static + KeysInterface<Signer = Signer>,
	F::Target: 'static + FeeEstimator,
	L::Target: 'static + Logger,
{
	/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
	/// (which will cause the [`BackgroundProcessor`] which called this method to exit).
@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.
@johncantrell97johncantrell97Apr 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

hm the BP docs already also have this:
/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or

/// uploading to one or more backup services. See [ChannelManager::write] for writing out a

/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's

/// provided implementation.
could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.
	fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

	/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
	fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
	///
	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
	/// provided implementation.
	///
	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
	/// for Rust-Lightning's provided implementation.
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
	/// for LDK's provided implementation.
	///
	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
	/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
	/// [`stop`]: Self::stop
	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
	/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
	/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
	/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
	pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
 CMH: 'static + Deref + Send + Sync,
 RMH: 'static + Deref + Send + Sync,
 EH: 'static + EventHandler + Send,
 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
 PS: 'static + Deref + Send,
 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
 CMH::Target: 'static + ChannelMessageHandler,
 RMH::Target: 'static + RoutingMessageHandler,
 UMH::Target: 'static + CustomMessageHandler,
 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
	{
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
	use lightning::util::logger::Logger;
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::fs::{self, File};
	use std::ops::Deref;
	use std::path::PathBuf;
	use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
	struct Persister {
 data_dir: String,
 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 manager_error: Option<(std::io::ErrorKind, &'static str)>
 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 filesystem_persister: FilesystemPersister,
	}

	impl Persister {
 fn new(data_dir: String) -> Self {
 Self { data_dir, graph_error: None, manager_error: None }
 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
 Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
 }

 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
 }
	}

	impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
 M::Target: 'static + chain::Watch<Signer>,
 T::Target: 'static + BroadcasterInterface,
 K::Target: 'static + KeysInterface<Signer = Signer>,
 F::Target: 'static + FeeEstimator,
 L::Target: 'static + Logger,
	{
 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
 match self.manager_error {
 None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
 Some((error, message)) => Err(std::io::Error::new(error, message)),
	impl KVStorePersister for Persister {
 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 if key == "manager" {
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message))
 }
 }
 }

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
	if key == "network_graph" {
	if let Some((error, message)) = self.graph_error {
	return Err(std::io::Error::new(error, message))
}
 }

 self.filesystem_persister.persist(key, object)
 }
	}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
 // `FRESHNESS_TIMER`.
 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
 open_channel!(nodes[0], nodes[1], 100000);

 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
 // Test that if we encounter an error during network graph persistence, an error gets returned.
 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 let channel_value = 100000;
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir.clone());
 let persister = Arc::new(Persister::new(data_dir.clone()));

 // Set up a background event handler for FundingGenerationReady events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
 // Set up a background event handler for SpendableOutputs events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
 let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 let persister = Arc::new(Persister::new(data_dir));
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down

94 changes: 11 additions & 83 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
	path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
 self.write(writer)
	}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
	M::Target: chain::Watch<Signer>,
	T::Target: BroadcasterInterface,
	K::Target: KeysInterface<Signer=Signer>,
	F::Target: FeeEstimator,
	L::Target: Logger,
{
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl DiskWriteable for NetworkGraph {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl FilesystemPersister {
	/// Initialize a new FilesystemPersister and set the path to the individual channels'
	/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
 self.path_to_channel_data.clone()
	}

	pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
 let mut path = PathBuf::from(self.path_to_channel_data.clone());
 path.push("monitors");
 path
	}

	/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "manager".
	pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 data_dir: String,
 manager: &ChannelManager<Signer, M, T, K, F, L>
	) -> Result<(), std::io::Error>
	where
 M::Target: chain::Watch<Signer>,
 T::Target: BroadcasterInterface,
 K::Target: KeysInterface<Signer=Signer>,
 F::Target: FeeEstimator,
 L::Target: Logger,
	{
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "manager".to_string(), manager)
	}

	/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "network_graph"
	pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "network_graph".to_string(), network_graph)
	}

	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized,
	{
 let path = self.path_to_monitor_data();
 let mut path = PathBuf::from(&self.path_to_channel_data);
 path.push("monitors");
 if !Path::new(&path).exists() {
 return Ok(Vec::new());
 }
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
	}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
	// TODO: We really need a way for the persister to inform the user that its time to crash/shut
	// down once these start returning failure.
	// A PermanentFailure implies we need to shut down since we're force-closing channels without
	// even broadcasting!

	fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
	}

	fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);

Comment on lines

+124
 to 
+125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?
@johncantrell97johncantrell97Apr 20, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Like this?
let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

 util::write_to_file(dest_file, object)
	}
}

Expand Down
Loading

, '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
add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417

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 21, 2022
 Merged


add KVStorePersister trait and blanket implementations of Persist and Persister for any type that implements KVStorePersister#1417
Show file tree
Hide file tree
 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


2 changes: 1 addition & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.106", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

[dev-dependencies]
lightning = { version = "0.0.106", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.14.0", path = "../lightning-invoice" }
lightning-persister = { version = "0.0.106", path = "../lightning-persister" }

82 changes: 34 additions & 48 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescr
use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
use lightning::util::events::{Event, EventHandler, EventsProvider};
use lightning::util::logger::Logger;
use lightning::util::persist::Persister;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::thread;
Expand DownExpand Up@@ -80,22 +81,6 @@ const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
#[cfg(test)]
const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;

/// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
where
	M::Target: 'static + chain::Watch<Signer>,
	T::Target: 'static + BroadcasterInterface,
	K::Target: 'static + KeysInterface<Signer = Signer>,
	F::Target: 'static + FeeEstimator,
	L::Target: 'static + Logger,
{
	/// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
	/// (which will cause the [`BackgroundProcessor`] which called this method to exit).
@TheBlueMattTheBlueMattApr 12, 2022

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.

We should move this line somewhere else in the BP docs, I'd think, not move it to the lightning-persister crate.
@johncantrell97johncantrell97Apr 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

hm the BP docs already also have this:
/// [Persister::persist_manager] is responsible for writing out the [ChannelManager] to disk, and/or

/// uploading to one or more backup services. See [ChannelManager::write] for writing out a

/// [ChannelManager]. See [FilesystemPersister::persist_manager] for Rust-Lightning's

/// provided implementation.
could just add the bit about failure causing BP to exit. also should update the bit here about the provided implementation.
	fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;

	/// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
	fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
}

/// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
struct DecoratingEventHandler<
Expand DownExpand Up@@ -138,12 +123,12 @@ impl BackgroundProcessor {
	///
	/// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
	/// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
	/// provided implementation.
	///
	/// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
	/// for Rust-Lightning's provided implementation.
	/// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
	/// for LDK's provided implementation.
	///
	/// Typically, users should either implement [`Persister::persist_manager`] to never return an
	/// error or call [`join`] and handle any error that may arise. For the latter case,
Expand All@@ -161,8 +146,8 @@ impl BackgroundProcessor {
	/// [`stop`]: Self::stop
	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
	/// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
	/// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
	/// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
	/// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
	/// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
	pub fn start<
Expand All@@ -180,7 +165,7 @@ impl BackgroundProcessor {
 CMH: 'static + Deref + Send + Sync,
 RMH: 'static + Deref + Send + Sync,
 EH: 'static + EventHandler + Send,
 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
 PS: 'static + Deref + Send,
 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
Expand All@@ -202,6 +187,7 @@ impl BackgroundProcessor {
 CMH::Target: 'static + ChannelMessageHandler,
 RMH::Target: 'static + RoutingMessageHandler,
 UMH::Target: 'static + CustomMessageHandler,
 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
	{
 let stop_thread = Arc::new(AtomicBool::new(false));
 let stop_thread_clone = stop_thread.clone();
Expand DownExpand Up@@ -365,10 +351,11 @@ mod tests {
	use lightning::util::logger::Logger;
	use lightning::util::ser::Writeable;
	use lightning::util::test_utils;
	use lightning::util::persist::KVStorePersister;
	use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
	use lightning_invoice::utils::DefaultRouter;
	use lightning_persister::FilesystemPersister;
	use std::fs;
	use std::fs::{self, File};
	use std::ops::Deref;
	use std::path::PathBuf;
	use std::sync::{Arc, Mutex};
Expand DownExpand Up@@ -414,12 +401,14 @@ mod tests {
	struct Persister {
 data_dir: String,
 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 manager_error: Option<(std::io::ErrorKind, &'static str)>
 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 filesystem_persister: FilesystemPersister,
	}

	impl Persister {
 fn new(data_dir: String) -> Self {
 Self { data_dir, graph_error: None, manager_error: None }
 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
 Self { data_dir, graph_error: None, manager_error: None, filesystem_persister }
 }

 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
Expand All@@ -431,25 +420,21 @@ mod tests {
 }
	}

	impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
 M::Target: 'static + chain::Watch<Signer>,
 T::Target: 'static + BroadcasterInterface,
 K::Target: 'static + KeysInterface<Signer = Signer>,
 F::Target: 'static + FeeEstimator,
 L::Target: 'static + Logger,
	{
 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
 match self.manager_error {
 None => FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager),
 Some((error, message)) => Err(std::io::Error::new(error, message)),
	impl KVStorePersister for Persister {
 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 if key == "manager" {
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message))
 }
 }
 }

fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
match self.graph_error {
None => FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph),
Some((error, message)) => Err(std::io::Error::new(error, message)),
	if key == "network_graph" {
	if let Some((error, message)) = self.graph_error {
	return Err(std::io::Error::new(error, message))
}
 }

 self.filesystem_persister.persist(key, object)
 }
	}

Expand DownExpand Up@@ -576,7 +561,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand DownExpand Up@@ -637,7 +622,7 @@ mod tests {
 // `FRESHNESS_TIMER`.
 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 loop {
Expand All@@ -660,7 +645,7 @@ mod tests {
 open_channel!(nodes[0], nodes[1], 100000);

 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 match bg_processor.join() {
Expand All@@ -677,7 +662,7 @@ mod tests {
 // Test that if we encounter an error during network graph persistence, an error gets returned.
 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test");
 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
 let event_handler = |_: &_| {};
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

Expand All@@ -695,7 +680,7 @@ mod tests {
 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 let channel_value = 100000;
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir.clone());
 let persister = Arc::new(Persister::new(data_dir.clone()));

 // Set up a background event handler for FundingGenerationReady events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
Expand DownExpand Up@@ -726,7 +711,8 @@ mod tests {
 // Set up a background event handler for SpendableOutputs events.
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
 let bg_processor = BackgroundProcessor::start(Persister::new(data_dir), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 let persister = Arc::new(Persister::new(data_dir));
 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());

 // Force close the channel and check that the SpendableOutputs event was handled.
 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
Expand All@@ -752,7 +738,7 @@ mod tests {

 // Initiate the background processors to watch each node.
 let data_dir = nodes[0].persister.get_data_dir();
 let persister = Persister::new(data_dir);
 let persister = Arc::new(Persister::new(data_dir));
 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
Expand Down

94 changes: 11 additions & 83 deletions
lightning-persister/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,13 @@ extern crate bitcoin;
extern crate libc;

use bitcoin::hash_types::{BlockHash, Txid};
use bitcoin::hashes::hex::{FromHex, ToHex};
use lightning::routing::network_graph::NetworkGraph;
use crate::util::DiskWriteable;
use lightning::chain;
use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
use lightning::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate};
use lightning::chain::chainmonitor;
use bitcoin::hashes::hex::FromHex;
use lightning::chain::channelmonitor::ChannelMonitor;
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::{ReadableArgs, Writeable};
use lightning::util::persist::KVStorePersister;
use std::fs;
use std::io::{Cursor, Error, Write};
use std::io::Cursor;
use std::ops::Deref;
use std::path::{Path, PathBuf};

Expand All@@ -48,31 +41,6 @@ pub struct FilesystemPersister {
	path_to_channel_data: String,
}

impl<Signer: Sign> DiskWriteable for ChannelMonitor<Signer> {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
 self.write(writer)
	}
}

impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> DiskWriteable for ChannelManager<Signer, M, T, K, F, L>
where
	M::Target: chain::Watch<Signer>,
	T::Target: BroadcasterInterface,
	K::Target: KeysInterface<Signer=Signer>,
	F::Target: FeeEstimator,
	L::Target: Logger,
{
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl DiskWriteable for NetworkGraph {
	fn write_to_file<W: Write>(&self, writer: &mut W) -> Result<(), std::io::Error> {
 self.write(writer)
	}
}

impl FilesystemPersister {
	/// Initialize a new FilesystemPersister and set the path to the individual channels'
	/// files.
Expand All@@ -87,43 +55,14 @@ impl FilesystemPersister {
 self.path_to_channel_data.clone()
	}

	pub(crate) fn path_to_monitor_data(&self) -> PathBuf {
 let mut path = PathBuf::from(self.path_to_channel_data.clone());
 path.push("monitors");
 path
	}

	/// Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "manager".
	pub fn persist_manager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>(
 data_dir: String,
 manager: &ChannelManager<Signer, M, T, K, F, L>
	) -> Result<(), std::io::Error>
	where
 M::Target: chain::Watch<Signer>,
 T::Target: BroadcasterInterface,
 K::Target: KeysInterface<Signer=Signer>,
 F::Target: FeeEstimator,
 L::Target: Logger,
	{
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "manager".to_string(), manager)
	}

	/// Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
	/// initialization, within a file called "network_graph"
	pub fn persist_network_graph(data_dir: String, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
 let path = PathBuf::from(data_dir);
 util::write_to_file(path, "network_graph".to_string(), network_graph)
	}

	/// Read `ChannelMonitor`s from disk.
	pub fn read_channelmonitors<Signer: Sign, K: Deref> (
 &self, keys_manager: K
	) -> Result<Vec<(BlockHash, ChannelMonitor<Signer>)>, std::io::Error>
 where K::Target: KeysInterface<Signer=Signer> + Sized,
	{
 let path = self.path_to_monitor_data();
 let mut path = PathBuf::from(&self.path_to_channel_data);
 path.push("monitors");
 if !Path::new(&path).exists() {
 return Ok(Vec::new());
 }
Expand DownExpand Up@@ -180,22 +119,11 @@ impl FilesystemPersister {
	}
}

impl<ChannelSigner: Sign> chainmonitor::Persist<ChannelSigner> for FilesystemPersister {
	// TODO: We really need a way for the persister to inform the user that its time to crash/shut
	// down once these start returning failure.
	// A PermanentFailure implies we need to shut down since we're force-closing channels without
	// even broadcasting!

	fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
	}

	fn update_persisted_channel(&self, funding_txo: OutPoint, _update: &Option<ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: chainmonitor::MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 let filename = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
 util::write_to_file(self.path_to_monitor_data(), filename, monitor)
 .map_err(|_| chain::ChannelMonitorUpdateErr::PermanentFailure)
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);

Comment on lines

+124
 to 
+125

@jkczyzjkczyzApr 20, 2022

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 we allocate using PathBuf::with_capacity using the size of the two strings and then push a reference to self.path_to_channel_data and key?
@johncantrell97johncantrell97Apr 20, 2022

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Like this?
let mut dest_file = PathBuf::with_capacity(self.path_to_channel_data.len() + key.len());
dest_file.push(&self.path_to_channel_data);
dest_file.push(key);

 util::write_to_file(dest_file, object)
	}
}

Expand Down
Loading