Skip to content

Require PaginatedKVStore for all stores #943

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

Open
benthecarman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Require PaginatedKVStore for all stores #943

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
20 changes: 10 additions & 10 deletions src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ use lightning::routing::scoring::{
use lightning::sign::{EntropySource, NodeSigner};
use lightning::util::config::HTLCInterceptionFlags;
use lightning::util::persist::{
KVStore, CHANNEL_MANAGER_PERSISTENCE_KEY, CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
KVStore, PaginatedKVStore, CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
};
use lightning::util::ser::ReadableArgs;
use lightning::util::sweep::OutputSweeper;
Expand Down Expand Up @@ -254,7 +254,7 @@ impl std::error::Error for BuildError {}
/// - [`build`] uses an SQLite database (recommended default).
/// - [`build_with_fs_store`] uses a filesystem-based store.
/// - [`build_with_vss_store`] and variants use a [VSS] remote store (**experimental**).
/// - [`build_with_store`] allows providing a custom [`KVStore`] implementation.
/// - [`build_with_store`] allows providing a custom [`PaginatedKVStore`] implementation.
///
/// ### Logging
///
Expand All @@ -270,7 +270,7 @@ impl std::error::Error for BuildError {}
/// [`build_with_vss_store`]: Self::build_with_vss_store
/// [`build_with_store`]: Self::build_with_store
/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
/// [`KVStore`]: lightning::util::persist::KVStore
/// [`PaginatedKVStore`]: lightning::util::persist::PaginatedKVStore
/// [`DEFAULT_LOG_LEVEL`]: crate::config::DEFAULT_LOG_LEVEL
/// [`set_filesystem_logger`]: Self::set_filesystem_logger
/// [`set_log_facade_logger`]: Self::set_log_facade_logger
Expand Down Expand Up @@ -813,7 +813,7 @@ impl NodeBuilder {
}

/// Builds a [`Node`] instance according to the options previously configured.
pub fn build_with_store<S: KVStore + Send + Sync + 'static>(
pub fn build_with_store<S: PaginatedKVStore + Send + Sync + 'static>(
&self, node_entropy: NodeEntropy, kv_store: S,
) -> Result<Node, BuildError> {
let logger = setup_logger(&self.log_writer_config, &self.config)?;
Expand All @@ -832,14 +832,14 @@ impl NodeBuilder {
}
}

fn build_with_store_and_logger<S: KVStore + Send + Sync + 'static>(
fn build_with_store_and_logger<S: PaginatedKVStore + Send + Sync + 'static>(
&self, node_entropy: NodeEntropy, kv_store: S, logger: Arc<Logger>,
) -> Result<Node, BuildError> {
let runtime = self.setup_runtime(&logger)?;
self.build_with_store_runtime_and_logger(node_entropy, kv_store, runtime, logger)
}

fn build_with_store_runtime_and_logger<S: KVStore + Send + Sync + 'static>(
fn build_with_store_runtime_and_logger<S: PaginatedKVStore + Send + Sync + 'static>(
&self, node_entropy: NodeEntropy, kv_store: S, runtime: Arc<Runtime>, logger: Arc<Logger>,
) -> Result<Node, BuildError> {
let seed_bytes = node_entropy.to_seed_bytes();
Expand Down Expand Up @@ -876,7 +876,7 @@ impl NodeBuilder {
/// - [`build`] uses an SQLite database (recommended default).
/// - [`build_with_fs_store`] uses a filesystem-based store.
/// - [`build_with_vss_store`] and variants use a [VSS] remote store (**experimental**).
/// - [`build_with_store`] allows providing a custom [`KVStore`] implementation.
/// - [`build_with_store`] allows providing a custom [`PaginatedKVStore`] implementation.
///
/// ### Logging
///
Expand All @@ -892,7 +892,7 @@ impl NodeBuilder {
/// [`build_with_vss_store`]: Self::build_with_vss_store
/// [`build_with_store`]: Self::build_with_store
/// [VSS]: https://github.com/lightningdevkit/vss-server/blob/main/README.md
/// [`KVStore`]: lightning::util::persist::KVStore
/// [`PaginatedKVStore`]: lightning::util::persist::PaginatedKVStore
/// [`DEFAULT_LOG_LEVEL`]: crate::config::DEFAULT_LOG_LEVEL
/// [`set_filesystem_logger`]: Self::set_filesystem_logger
/// [`set_log_facade_logger`]: Self::set_log_facade_logger
Expand Down Expand Up @@ -1330,7 +1330,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
// Note that the generics here don't actually work for Uniffi, but we don't currently expose
// this so its not needed.
pub fn build_with_store<S: KVStore + Send + Sync + 'static>(
pub fn build_with_store<S: PaginatedKVStore + Send + Sync + 'static>(
&self, node_entropy: Arc<NodeEntropy>, kv_store: S,
) -> Result<Arc<Node>, BuildError> {
self.inner.read().expect("lock").build_with_store(*node_entropy, kv_store).map(Arc::new)
Expand Down
56 changes: 53 additions & 3 deletions src/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ use lightning::routing::gossip;
use lightning::routing::router::DefaultRouter;
use lightning::routing::scoring::{CombinedScorer, ProbabilisticScoringFeeParameters};
use lightning::sign::InMemorySigner;
use lightning::util::persist::{KVStore, MonitorUpdatingPersisterAsync};
use lightning::util::persist::{
KVStore, MonitorUpdatingPersisterAsync, PageToken, PaginatedKVStore, PaginatedListResponse,
};
use lightning::util::ser::{Readable, Writeable, Writer};
use lightning::util::sweep::OutputSweeper;
use lightning_block_sync::gossip::GossipVerifier;
Expand Down Expand Up @@ -59,6 +61,13 @@ pub(crate) trait DynStoreTrait: Send + Sync {
fn list_async(
&self, primary_namespace: &str, secondary_namespace: &str,
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, bitcoin::io::Error>> + Send + 'static>>;
fn list_paginated_async(
&self, primary_namespace: &str, secondary_namespace: &str, page_token: Option<PageToken>,
) -> Pin<
Box<
dyn Future<Output = Result<PaginatedListResponse, bitcoin::io::Error>> + Send + 'static,
>,
>;
}

impl<'a> KVStore for dyn DynStoreTrait + 'a {
Expand Down Expand Up @@ -87,6 +96,19 @@ impl<'a> KVStore for dyn DynStoreTrait + 'a {
}
}

impl<'a> PaginatedKVStore for dyn DynStoreTrait + 'a {
fn list_paginated(
&self, primary_namespace: &str, secondary_namespace: &str, page_token: Option<PageToken>,
) -> impl Future<Output = Result<PaginatedListResponse, bitcoin::io::Error>> + Send + 'static {
DynStoreTrait::list_paginated_async(
self,
primary_namespace,
secondary_namespace,
page_token,
)
}
}

pub(crate) type DynStore = dyn DynStoreTrait;

// Newtype wrapper that implements `KVStore` for `Arc<DynStore>`. This is needed because `KVStore`
Expand Down Expand Up @@ -122,9 +144,22 @@ impl KVStore for DynStoreRef {
}
}

pub(crate) struct DynStoreWrapper<T: KVStore + Send + Sync>(pub(crate) T);
impl PaginatedKVStore for DynStoreRef {
fn list_paginated(
&self, primary_namespace: &str, secondary_namespace: &str, page_token: Option<PageToken>,
) -> impl Future<Output = Result<PaginatedListResponse, bitcoin::io::Error>> + Send + 'static {
DynStoreTrait::list_paginated_async(
&*self.0,
primary_namespace,
secondary_namespace,
page_token,
)
}
}

pub(crate) struct DynStoreWrapper<T: PaginatedKVStore + Send + Sync>(pub(crate) T);

impl<T: KVStore + Send + Sync> DynStoreTrait for DynStoreWrapper<T> {
impl<T: PaginatedKVStore + Send + Sync> DynStoreTrait for DynStoreWrapper<T> {
fn read_async(
&self, primary_namespace: &str, secondary_namespace: &str, key: &str,
) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, bitcoin::io::Error>> + Send + 'static>> {
Expand All @@ -148,6 +183,21 @@ impl<T: KVStore + Send + Sync> DynStoreTrait for DynStoreWrapper<T> {
) -> Pin<Box<dyn Future<Output = Result<Vec<String>, bitcoin::io::Error>> + Send + 'static>> {
Box::pin(KVStore::list(&self.0, primary_namespace, secondary_namespace))
}

fn list_paginated_async(
&self, primary_namespace: &str, secondary_namespace: &str, page_token: Option<PageToken>,
) -> Pin<
Box<
dyn Future<Output = Result<PaginatedListResponse, bitcoin::io::Error>> + Send + 'static,
>,
> {
Box::pin(PaginatedKVStore::list_paginated(
&self.0,
primary_namespace,
secondary_namespace,
page_token,
))
}
}

pub(crate) type AsyncPersister = MonitorUpdatingPersisterAsync<
Expand Down
48 changes: 47 additions & 1 deletion tests/common/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ use ldk_node::{
use lightning::io;
use lightning::ln::msgs::SocketAddress;
use lightning::routing::gossip::NodeAlias;
use lightning::util::persist::KVStore;
use lightning::util::persist::{KVStore, PageToken, PaginatedKVStore, PaginatedListResponse};
use lightning_invoice::{Bolt11InvoiceDescription, Description};
use lightning_persister::fs_store::v1::FilesystemStore;
use lightning_types::payment::{PaymentHash, PaymentPreimage};
Expand Down Expand Up @@ -1702,6 +1702,21 @@ impl KVStore for TestSyncStore {
}
}

impl PaginatedKVStore for TestSyncStore {
fn list_paginated(
&self, primary_namespace: &str, secondary_namespace: &str, page_token: Option<PageToken>,
) -> impl Future<Output = Result<PaginatedListResponse, io::Error>> + 'static + Send {
let primary_namespace = primary_namespace.to_string();
let secondary_namespace = secondary_namespace.to_string();
let inner = Arc::clone(&self.inner);
async move {
inner
.list_paginated_internal_async(&primary_namespace, &secondary_namespace, page_token)
.await
}
}
}

struct TestSyncStoreInner {
serializer: tokio::sync::RwLock<()>,
test_store: InMemoryStore,
Expand Down Expand Up @@ -1765,6 +1780,37 @@ impl TestSyncStoreInner {
self.do_list_async(primary_namespace, secondary_namespace).await
}

async fn list_paginated_internal_async(
&self, primary_namespace: &str, secondary_namespace: &str, page_token: Option<PageToken>,
) -> lightning::io::Result<PaginatedListResponse> {
let _guard = self.serializer.read().await;
let sqlite_res = PaginatedKVStore::list_paginated(
&self.sqlite_store,
primary_namespace,
secondary_namespace,
page_token.clone(),
)
.await;
let test_res = PaginatedKVStore::list_paginated(
&self.test_store,
primary_namespace,
secondary_namespace,
page_token,
)
.await;

match sqlite_res {
Ok(sqlite_response) => {
assert_eq!(sqlite_response, test_res.unwrap());
Ok(sqlite_response)
},
Err(e) => {
assert!(test_res.is_err());
Err(e)
},
}
}

async fn read_internal_async(
&self, primary_namespace: &str, secondary_namespace: &str, key: &str,
) -> lightning::io::Result<Vec<u8>> {
Expand Down
Loading