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

Merged
tnull merged 1 commit into from
Jun 25, 2026
Merged

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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Require PaginatedKVStore for all stores by benthecarman · Pull Request #943 · lightningdevkit/ldk-node · GitHub
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

 Merged

tnull
merged 1 commit into

from

Jun 25, 2026
 Merged


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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Require PaginatedKVStore for all stores by benthecarman · Pull Request #943 · lightningdevkit/ldk-node · GitHub
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

 Merged

tnull
merged 1 commit into

from

Jun 25, 2026
 Merged


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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading

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

 Merged

tnull
merged 1 commit into

from

Jun 25, 2026
 Merged


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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading

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

 Merged

tnull
merged 1 commit into

from

Jun 25, 2026
 Merged


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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Require PaginatedKVStore for all stores by benthecarman · Pull Request #943 · lightningdevkit/ldk-node · GitHub
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

 Merged

tnull
merged 1 commit into

from

Jun 25, 2026
 Merged


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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Require PaginatedKVStore for all stores by benthecarman · Pull Request #943 · lightningdevkit/ldk-node · GitHub
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

 Merged

tnull
merged 1 commit into

from

Jun 25, 2026
 Merged


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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading

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

 Merged

tnull
merged 1 commit into

from

Jun 25, 2026
 Merged


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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,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 DownExpand Up@@ -67,6 +69,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 DownExpand Up@@ -95,6 +104,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 DownExpand Up@@ -130,9 +152,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@@ -156,6 +191,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 numberDiff line numberDiff 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 DownExpand 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 DownExpand 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
Loading