Optimize paginated payment listing queries#240

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

Closed
joostjager wants to merge 2 commits into from
Closed

Optimize paginated payment listing queries #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
953b3ed
Replace SQLite pagination index
joostjager Jul 3, 2026
d4adfb5
Fix payment listing N+1 queries
joostjager Jul 3, 2026
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
19 changes: 3 additions & 16 deletions ldk-server/src/api/list_forwarded_payments.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
let page_token = request.page_token.map(|p| (p.token, p.index));
let list_response = context
.paginated_kv_store
.list(
.list_values(
FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
})?;

let mut forwarded_payments: Vec<ForwardedPayment> =
Vec::with_capacity(list_response.keys.len());
for key in list_response.keys {
let forwarded_payment_bytes = context
.paginated_kv_store
.read(
FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
&key,
)
.map_err(|e| {
LdkServerError::new(
InternalServerError,
format!("Failed to read forwarded payment data: {}", e),
)
})?;
Vec::with_capacity(list_response.items.len());
for (_, forwarded_payment_bytes) in list_response.items {
let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
.map_err(|e| {
LdkServerError::new(
Expand Down
19 changes: 3 additions & 16 deletions ldk-server/src/api/list_payments.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
let page_token = request.page_token.map(|p| (p.token, p.index));
let list_response = context
.paginated_kv_store
.list(
.list_values(
PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
})?;

let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
for key in list_response.keys {
let payment_bytes = context
.paginated_kv_store
.read(
PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
&key,
)
.map_err(|e| {
LdkServerError::new(
InternalServerError,
format!("Failed to read payment data: {}", e),
)
})?;
let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
for (_, payment_bytes) in list_response.items {
let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
})?;
Expand Down
24 changes: 24 additions & 0 deletions ldk-server/src/io/persist/paginated_kv_store.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
/// `primary_namespace` and `secondary_namespace`.
///
/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
#[cfg_attr(not(test), allow(dead_code))]
fn read(
&self, primary_namespace: &str, secondary_namespace: &str, key: &str,
) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
/// there are no more keys to return.
///
/// [`ListResponse`]: struct.ListResponse.html
#[cfg_attr(not(test), allow(dead_code))]
fn list(
&self, primary_namespace: &str, secondary_namespace: &str,
next_page_token: Option<(String, i64)>,
) -> Result<ListResponse, io::Error>;

/// Returns a paginated list of keys and values that are stored under the given
/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
///
/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
fn list_values(
&self, primary_namespace: &str, secondary_namespace: &str,
next_page_token: Option<(String, i64)>,
) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
/// A vector of keys, ordered in descending order of `time`.
pub keys: Vec<String>,

/// A token that can be used to retrieve the next set of keys.
pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
/// A vector of key-value pairs, ordered in descending order of `time`.
pub items: Vec<(String, Vec<u8>)>,

/// A token that can be used to retrieve the next set of items.
pub next_page_token: Option<(String, i64)>,
}
115 changes: 110 additions & 5 deletions ldk-server/src/io/persist/sqlite_store/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
io::Error::other(msg)
})?;

let index_creation_time_sql = format!(
"CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
let index_paginated_kv_namespace_time_key_sql = format!(
"CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
primary_namespace,
secondary_namespace,
creation_time DESC,
key ASC
);",
paginated_kv_table_name
);

connection.execute(&index_creation_time_sql, []).map_err(|e| {
connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
let msg = format!(
"Failed to create index on creation_time, table {}: {}",
"Failed to create paginated namespace index, table {}: {}",
paginated_kv_table_name, e
);
io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
Ok(Self { connection, paginated_kv_table_name })
}

#[cfg_attr(not(test), allow(dead_code))]
fn read_internal(
&self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

Ok(ListResponse { keys, next_page_token })
}

fn list_values(
&self, primary_namespace: &str, secondary_namespace: &str,
page_token: Option<(String, i64)>,
) -> io::Result<ListValuesResponse> {
check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

let locked_conn = self.connection.lock().unwrap();

// The cursor predicate is paired with this exact ordering: newer creation times first,
// then keys ascending to make rows with the same creation time deterministic.
let sql = format!(
"SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
ORDER BY creation_time DESC, key ASC LIMIT :page_size",
self.paginated_kv_table_name
);

let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
let msg = format!("Failed to prepare statement: {}", e);
io::Error::other(msg)
})?;

let mut items: Vec<(String, Vec<u8>)> = Vec::new();
let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

let rows_iter = stmt
.query_map(
named_params! {
":primary_namespace": primary_namespace,
":secondary_namespace": secondary_namespace,
":key_token": page_token.0,
":creation_time_token": page_token.1,
":page_size": LIST_KEYS_MAX_PAGE_SIZE,
},
|row| {
let key: String = row.get(0)?;
let creation_time: i64 = row.get(1)?;
let value: Vec<u8> = row.get(2)?;
Ok((key, creation_time, value))
},
)
.map_err(|e| {
let msg = format!("Failed to retrieve queried rows: {}", e);
io::Error::other(msg)
})?;

let mut last_creation_time: Option<i64> = None;
for r in rows_iter {
let (k, ct, value) = r.map_err(|e| {
let msg = format!("Failed to retrieve queried rows: {}", e);
io::Error::other(msg)
})?;
items.push((k, value));
last_creation_time = Some(ct);
}

let last_key = items.last().map(|(key, _)| key.clone());
// Match list's token behavior: EOF is confirmed by a following empty page, not by
// withholding the token from a short non-empty page.
let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
Some((k, ct))
} else {
None
};

Ok(ListValuesResponse { items, next_page_token })
}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
all_keys
};

let list_all_items =
|primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
let mut all_items = Vec::new();
let mut page_token = None;
loop {
let list_response = kv_store
.list_values(primary_namespace, secondary_namespace, page_token)
.unwrap();
assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
all_items.extend(list_response.items);
if list_response.next_page_token.is_none() {
break;
}
page_token = list_response.next_page_token;
}
all_items
};

// Test the basic KVStore operations.
for i in 0..110 {
kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
assert_eq!(listed_keys.len(), 110);
assert_eq!(listed_keys[0], testkey);

let listed_items = list_all_items(primary_namespace, secondary_namespace);
let listed_item_keys: Vec<String> =
listed_items.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(listed_item_keys, listed_keys);
for (_, value) in listed_items {
assert_eq!(data, &*value);
}

let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
assert_eq!(listed_keys.len(), 1);
assert_eq!(listed_keys[0], max_chars);

let listed_items = list_all_items(&max_chars, &max_chars);
assert_eq!(listed_items.len(), 1);
assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
assert_eq!(data, listed_items[0].1.as_slice());

let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
assert_eq!(data, &*read_data);
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Optimize paginated payment listing queries#240

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Optimize paginated payment listing queries
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
953b3ed

Replace SQLite pagination index


joostjager Jul 3, 2026
d4adfb5

Fix payment listing N+1 queries


joostjager Jul 3, 2026

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


19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_forwarded_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
 })?;

	let mut forwarded_payments: Vec<ForwardedPayment> =
 Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let forwarded_payment_bytes = context
 .paginated_kv_store
 .read(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read forwarded payment data: {}", e),
 )
 })?;
 Vec::with_capacity(list_response.items.len());
	for (_, forwarded_payment_bytes) in list_response.items {
 let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
 .map_err(|e| {
 LdkServerError::new(
Expand Down

19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
 LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
 })?;

	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let payment_bytes = context
 .paginated_kv_store
 .read(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read payment data: {}", e),
 )
 })?;
	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
	for (_, payment_bytes) in list_response.items {
 let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
 LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
 })?;
Expand Down

24 changes: 24 additions & 0 deletions
ldk-server/src/io/persist/paginated_kv_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
	/// `primary_namespace` and `secondary_namespace`.
	///
	/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
	#[cfg_attr(not(test), allow(dead_code))]
	fn read(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
	/// there are no more keys to return.
	///
	/// [`ListResponse`]: struct.ListResponse.html
	#[cfg_attr(not(test), allow(dead_code))]
	fn list(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListResponse, io::Error>;

	/// Returns a paginated list of keys and values that are stored under the given
	/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
	///
	/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
	/// A vector of keys, ordered in descending order of `time`.
	pub keys: Vec<String>,

	/// A token that can be used to retrieve the next set of keys.
	pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
	/// A vector of key-value pairs, ordered in descending order of `time`.
	pub items: Vec<(String, Vec<u8>)>,

	/// A token that can be used to retrieve the next set of items.
	pub next_page_token: Option<(String, i64)>,
}

115 changes: 110 additions & 5 deletions
ldk-server/src/io/persist/sqlite_store/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
 io::Error::other(msg)
 })?;

 let index_creation_time_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
 let index_paginated_kv_namespace_time_key_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
 primary_namespace,
 secondary_namespace,
 creation_time DESC,
 key ASC
 );",
 paginated_kv_table_name
 );

 connection.execute(&index_creation_time_sql, []).map_err(|e| {
 connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
 let msg = format!(
 "Failed to create index on creation_time, table {}: {}",
 "Failed to create paginated namespace index, table {}: {}",
 paginated_kv_table_name, e
 );
 io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
 Ok(Self { connection, paginated_kv_table_name })
	}

	#[cfg_attr(not(test), allow(dead_code))]
	fn read_internal(
 &self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

 Ok(ListResponse { keys, next_page_token })
	}

	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 page_token: Option<(String, i64)>,
	) -> io::Result<ListValuesResponse> {
 check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

 let locked_conn = self.connection.lock().unwrap();

 // The cursor predicate is paired with this exact ordering: newer creation times first,
 // then keys ascending to make rows with the same creation time deterministic.
 let sql = format!(
 "SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
 AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
 ORDER BY creation_time DESC, key ASC LIMIT :page_size",
 self.paginated_kv_table_name
 );

 let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
 let msg = format!("Failed to prepare statement: {}", e);
 io::Error::other(msg)
 })?;

 let mut items: Vec<(String, Vec<u8>)> = Vec::new();
 let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

 let rows_iter = stmt
 .query_map(
 named_params! {
 ":primary_namespace": primary_namespace,
 ":secondary_namespace": secondary_namespace,
 ":key_token": page_token.0,
 ":creation_time_token": page_token.1,
 ":page_size": LIST_KEYS_MAX_PAGE_SIZE,
 },
 |row| {
 let key: String = row.get(0)?;
 let creation_time: i64 = row.get(1)?;
 let value: Vec<u8> = row.get(2)?;
 Ok((key, creation_time, value))
 },
 )
 .map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;

 let mut last_creation_time: Option<i64> = None;
 for r in rows_iter {
 let (k, ct, value) = r.map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;
 items.push((k, value));
 last_creation_time = Some(ct);
 }

 let last_key = items.last().map(|(key, _)| key.clone());
 // Match list's token behavior: EOF is confirmed by a following empty page, not by
 // withholding the token from a short non-empty page.
 let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
 Some((k, ct))
 } else {
 None
 };

 Ok(ListValuesResponse { items, next_page_token })
	}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
 all_keys
 };

 let list_all_items =
 |primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
 let mut all_items = Vec::new();
 let mut page_token = None;
 loop {
 let list_response = kv_store
 .list_values(primary_namespace, secondary_namespace, page_token)
 .unwrap();
 assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
 all_items.extend(list_response.items);
 if list_response.next_page_token.is_none() {
 break;
 }
 page_token = list_response.next_page_token;
 }
 all_items
 };

 // Test the basic KVStore operations.
 for i in 0..110 {
 kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
 assert_eq!(listed_keys.len(), 110);
 assert_eq!(listed_keys[0], testkey);

 let listed_items = list_all_items(primary_namespace, secondary_namespace);
 let listed_item_keys: Vec<String> =
 listed_items.iter().map(|(key, _)| key.clone()).collect();
 assert_eq!(listed_item_keys, listed_keys);
 for (_, value) in listed_items {
 assert_eq!(data, &*value);
 }

 let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
 assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
 assert_eq!(listed_keys.len(), 1);
 assert_eq!(listed_keys[0], max_chars);

 let listed_items = list_all_items(&max_chars, &max_chars);
 assert_eq!(listed_items.len(), 1);
 assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
 assert_eq!(data, listed_items[0].1.as_slice());

 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
 assert_eq!(data, &*read_data);
	}
Expand Down
Loading

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

Skip to content
Optimize paginated payment listing queries#240

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Optimize paginated payment listing queries
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
953b3ed

Replace SQLite pagination index


joostjager Jul 3, 2026
d4adfb5

Fix payment listing N+1 queries


joostjager Jul 3, 2026

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


19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_forwarded_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
 })?;

	let mut forwarded_payments: Vec<ForwardedPayment> =
 Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let forwarded_payment_bytes = context
 .paginated_kv_store
 .read(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read forwarded payment data: {}", e),
 )
 })?;
 Vec::with_capacity(list_response.items.len());
	for (_, forwarded_payment_bytes) in list_response.items {
 let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
 .map_err(|e| {
 LdkServerError::new(
Expand Down

19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
 LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
 })?;

	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let payment_bytes = context
 .paginated_kv_store
 .read(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read payment data: {}", e),
 )
 })?;
	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
	for (_, payment_bytes) in list_response.items {
 let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
 LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
 })?;
Expand Down

24 changes: 24 additions & 0 deletions
ldk-server/src/io/persist/paginated_kv_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
	/// `primary_namespace` and `secondary_namespace`.
	///
	/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
	#[cfg_attr(not(test), allow(dead_code))]
	fn read(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
	/// there are no more keys to return.
	///
	/// [`ListResponse`]: struct.ListResponse.html
	#[cfg_attr(not(test), allow(dead_code))]
	fn list(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListResponse, io::Error>;

	/// Returns a paginated list of keys and values that are stored under the given
	/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
	///
	/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
	/// A vector of keys, ordered in descending order of `time`.
	pub keys: Vec<String>,

	/// A token that can be used to retrieve the next set of keys.
	pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
	/// A vector of key-value pairs, ordered in descending order of `time`.
	pub items: Vec<(String, Vec<u8>)>,

	/// A token that can be used to retrieve the next set of items.
	pub next_page_token: Option<(String, i64)>,
}

115 changes: 110 additions & 5 deletions
ldk-server/src/io/persist/sqlite_store/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
 io::Error::other(msg)
 })?;

 let index_creation_time_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
 let index_paginated_kv_namespace_time_key_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
 primary_namespace,
 secondary_namespace,
 creation_time DESC,
 key ASC
 );",
 paginated_kv_table_name
 );

 connection.execute(&index_creation_time_sql, []).map_err(|e| {
 connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
 let msg = format!(
 "Failed to create index on creation_time, table {}: {}",
 "Failed to create paginated namespace index, table {}: {}",
 paginated_kv_table_name, e
 );
 io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
 Ok(Self { connection, paginated_kv_table_name })
	}

	#[cfg_attr(not(test), allow(dead_code))]
	fn read_internal(
 &self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

 Ok(ListResponse { keys, next_page_token })
	}

	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 page_token: Option<(String, i64)>,
	) -> io::Result<ListValuesResponse> {
 check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

 let locked_conn = self.connection.lock().unwrap();

 // The cursor predicate is paired with this exact ordering: newer creation times first,
 // then keys ascending to make rows with the same creation time deterministic.
 let sql = format!(
 "SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
 AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
 ORDER BY creation_time DESC, key ASC LIMIT :page_size",
 self.paginated_kv_table_name
 );

 let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
 let msg = format!("Failed to prepare statement: {}", e);
 io::Error::other(msg)
 })?;

 let mut items: Vec<(String, Vec<u8>)> = Vec::new();
 let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

 let rows_iter = stmt
 .query_map(
 named_params! {
 ":primary_namespace": primary_namespace,
 ":secondary_namespace": secondary_namespace,
 ":key_token": page_token.0,
 ":creation_time_token": page_token.1,
 ":page_size": LIST_KEYS_MAX_PAGE_SIZE,
 },
 |row| {
 let key: String = row.get(0)?;
 let creation_time: i64 = row.get(1)?;
 let value: Vec<u8> = row.get(2)?;
 Ok((key, creation_time, value))
 },
 )
 .map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;

 let mut last_creation_time: Option<i64> = None;
 for r in rows_iter {
 let (k, ct, value) = r.map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;
 items.push((k, value));
 last_creation_time = Some(ct);
 }

 let last_key = items.last().map(|(key, _)| key.clone());
 // Match list's token behavior: EOF is confirmed by a following empty page, not by
 // withholding the token from a short non-empty page.
 let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
 Some((k, ct))
 } else {
 None
 };

 Ok(ListValuesResponse { items, next_page_token })
	}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
 all_keys
 };

 let list_all_items =
 |primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
 let mut all_items = Vec::new();
 let mut page_token = None;
 loop {
 let list_response = kv_store
 .list_values(primary_namespace, secondary_namespace, page_token)
 .unwrap();
 assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
 all_items.extend(list_response.items);
 if list_response.next_page_token.is_none() {
 break;
 }
 page_token = list_response.next_page_token;
 }
 all_items
 };

 // Test the basic KVStore operations.
 for i in 0..110 {
 kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
 assert_eq!(listed_keys.len(), 110);
 assert_eq!(listed_keys[0], testkey);

 let listed_items = list_all_items(primary_namespace, secondary_namespace);
 let listed_item_keys: Vec<String> =
 listed_items.iter().map(|(key, _)| key.clone()).collect();
 assert_eq!(listed_item_keys, listed_keys);
 for (_, value) in listed_items {
 assert_eq!(data, &*value);
 }

 let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
 assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
 assert_eq!(listed_keys.len(), 1);
 assert_eq!(listed_keys[0], max_chars);

 let listed_items = list_all_items(&max_chars, &max_chars);
 assert_eq!(listed_items.len(), 1);
 assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
 assert_eq!(data, listed_items[0].1.as_slice());

 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
 assert_eq!(data, &*read_data);
	}
Expand Down
Loading

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

Skip to content
Optimize paginated payment listing queries#240

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Optimize paginated payment listing queries
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
953b3ed

Replace SQLite pagination index


joostjager Jul 3, 2026
d4adfb5

Fix payment listing N+1 queries


joostjager Jul 3, 2026

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


19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_forwarded_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
 })?;

	let mut forwarded_payments: Vec<ForwardedPayment> =
 Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let forwarded_payment_bytes = context
 .paginated_kv_store
 .read(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read forwarded payment data: {}", e),
 )
 })?;
 Vec::with_capacity(list_response.items.len());
	for (_, forwarded_payment_bytes) in list_response.items {
 let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
 .map_err(|e| {
 LdkServerError::new(
Expand Down

19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
 LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
 })?;

	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let payment_bytes = context
 .paginated_kv_store
 .read(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read payment data: {}", e),
 )
 })?;
	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
	for (_, payment_bytes) in list_response.items {
 let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
 LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
 })?;
Expand Down

24 changes: 24 additions & 0 deletions
ldk-server/src/io/persist/paginated_kv_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
	/// `primary_namespace` and `secondary_namespace`.
	///
	/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
	#[cfg_attr(not(test), allow(dead_code))]
	fn read(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
	/// there are no more keys to return.
	///
	/// [`ListResponse`]: struct.ListResponse.html
	#[cfg_attr(not(test), allow(dead_code))]
	fn list(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListResponse, io::Error>;

	/// Returns a paginated list of keys and values that are stored under the given
	/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
	///
	/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
	/// A vector of keys, ordered in descending order of `time`.
	pub keys: Vec<String>,

	/// A token that can be used to retrieve the next set of keys.
	pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
	/// A vector of key-value pairs, ordered in descending order of `time`.
	pub items: Vec<(String, Vec<u8>)>,

	/// A token that can be used to retrieve the next set of items.
	pub next_page_token: Option<(String, i64)>,
}

115 changes: 110 additions & 5 deletions
ldk-server/src/io/persist/sqlite_store/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
 io::Error::other(msg)
 })?;

 let index_creation_time_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
 let index_paginated_kv_namespace_time_key_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
 primary_namespace,
 secondary_namespace,
 creation_time DESC,
 key ASC
 );",
 paginated_kv_table_name
 );

 connection.execute(&index_creation_time_sql, []).map_err(|e| {
 connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
 let msg = format!(
 "Failed to create index on creation_time, table {}: {}",
 "Failed to create paginated namespace index, table {}: {}",
 paginated_kv_table_name, e
 );
 io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
 Ok(Self { connection, paginated_kv_table_name })
	}

	#[cfg_attr(not(test), allow(dead_code))]
	fn read_internal(
 &self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

 Ok(ListResponse { keys, next_page_token })
	}

	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 page_token: Option<(String, i64)>,
	) -> io::Result<ListValuesResponse> {
 check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

 let locked_conn = self.connection.lock().unwrap();

 // The cursor predicate is paired with this exact ordering: newer creation times first,
 // then keys ascending to make rows with the same creation time deterministic.
 let sql = format!(
 "SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
 AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
 ORDER BY creation_time DESC, key ASC LIMIT :page_size",
 self.paginated_kv_table_name
 );

 let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
 let msg = format!("Failed to prepare statement: {}", e);
 io::Error::other(msg)
 })?;

 let mut items: Vec<(String, Vec<u8>)> = Vec::new();
 let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

 let rows_iter = stmt
 .query_map(
 named_params! {
 ":primary_namespace": primary_namespace,
 ":secondary_namespace": secondary_namespace,
 ":key_token": page_token.0,
 ":creation_time_token": page_token.1,
 ":page_size": LIST_KEYS_MAX_PAGE_SIZE,
 },
 |row| {
 let key: String = row.get(0)?;
 let creation_time: i64 = row.get(1)?;
 let value: Vec<u8> = row.get(2)?;
 Ok((key, creation_time, value))
 },
 )
 .map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;

 let mut last_creation_time: Option<i64> = None;
 for r in rows_iter {
 let (k, ct, value) = r.map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;
 items.push((k, value));
 last_creation_time = Some(ct);
 }

 let last_key = items.last().map(|(key, _)| key.clone());
 // Match list's token behavior: EOF is confirmed by a following empty page, not by
 // withholding the token from a short non-empty page.
 let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
 Some((k, ct))
 } else {
 None
 };

 Ok(ListValuesResponse { items, next_page_token })
	}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
 all_keys
 };

 let list_all_items =
 |primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
 let mut all_items = Vec::new();
 let mut page_token = None;
 loop {
 let list_response = kv_store
 .list_values(primary_namespace, secondary_namespace, page_token)
 .unwrap();
 assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
 all_items.extend(list_response.items);
 if list_response.next_page_token.is_none() {
 break;
 }
 page_token = list_response.next_page_token;
 }
 all_items
 };

 // Test the basic KVStore operations.
 for i in 0..110 {
 kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
 assert_eq!(listed_keys.len(), 110);
 assert_eq!(listed_keys[0], testkey);

 let listed_items = list_all_items(primary_namespace, secondary_namespace);
 let listed_item_keys: Vec<String> =
 listed_items.iter().map(|(key, _)| key.clone()).collect();
 assert_eq!(listed_item_keys, listed_keys);
 for (_, value) in listed_items {
 assert_eq!(data, &*value);
 }

 let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
 assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
 assert_eq!(listed_keys.len(), 1);
 assert_eq!(listed_keys[0], max_chars);

 let listed_items = list_all_items(&max_chars, &max_chars);
 assert_eq!(listed_items.len(), 1);
 assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
 assert_eq!(data, listed_items[0].1.as_slice());

 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
 assert_eq!(data, &*read_data);
	}
Expand Down
Loading

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

Skip to content
Optimize paginated payment listing queries#240

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Optimize paginated payment listing queries
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
953b3ed

Replace SQLite pagination index


joostjager Jul 3, 2026
d4adfb5

Fix payment listing N+1 queries


joostjager Jul 3, 2026

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


19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_forwarded_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
 })?;

	let mut forwarded_payments: Vec<ForwardedPayment> =
 Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let forwarded_payment_bytes = context
 .paginated_kv_store
 .read(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read forwarded payment data: {}", e),
 )
 })?;
 Vec::with_capacity(list_response.items.len());
	for (_, forwarded_payment_bytes) in list_response.items {
 let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
 .map_err(|e| {
 LdkServerError::new(
Expand Down

19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
 LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
 })?;

	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let payment_bytes = context
 .paginated_kv_store
 .read(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read payment data: {}", e),
 )
 })?;
	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
	for (_, payment_bytes) in list_response.items {
 let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
 LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
 })?;
Expand Down

24 changes: 24 additions & 0 deletions
ldk-server/src/io/persist/paginated_kv_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
	/// `primary_namespace` and `secondary_namespace`.
	///
	/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
	#[cfg_attr(not(test), allow(dead_code))]
	fn read(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
	/// there are no more keys to return.
	///
	/// [`ListResponse`]: struct.ListResponse.html
	#[cfg_attr(not(test), allow(dead_code))]
	fn list(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListResponse, io::Error>;

	/// Returns a paginated list of keys and values that are stored under the given
	/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
	///
	/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
	/// A vector of keys, ordered in descending order of `time`.
	pub keys: Vec<String>,

	/// A token that can be used to retrieve the next set of keys.
	pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
	/// A vector of key-value pairs, ordered in descending order of `time`.
	pub items: Vec<(String, Vec<u8>)>,

	/// A token that can be used to retrieve the next set of items.
	pub next_page_token: Option<(String, i64)>,
}

115 changes: 110 additions & 5 deletions
ldk-server/src/io/persist/sqlite_store/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
 io::Error::other(msg)
 })?;

 let index_creation_time_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
 let index_paginated_kv_namespace_time_key_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
 primary_namespace,
 secondary_namespace,
 creation_time DESC,
 key ASC
 );",
 paginated_kv_table_name
 );

 connection.execute(&index_creation_time_sql, []).map_err(|e| {
 connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
 let msg = format!(
 "Failed to create index on creation_time, table {}: {}",
 "Failed to create paginated namespace index, table {}: {}",
 paginated_kv_table_name, e
 );
 io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
 Ok(Self { connection, paginated_kv_table_name })
	}

	#[cfg_attr(not(test), allow(dead_code))]
	fn read_internal(
 &self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

 Ok(ListResponse { keys, next_page_token })
	}

	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 page_token: Option<(String, i64)>,
	) -> io::Result<ListValuesResponse> {
 check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

 let locked_conn = self.connection.lock().unwrap();

 // The cursor predicate is paired with this exact ordering: newer creation times first,
 // then keys ascending to make rows with the same creation time deterministic.
 let sql = format!(
 "SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
 AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
 ORDER BY creation_time DESC, key ASC LIMIT :page_size",
 self.paginated_kv_table_name
 );

 let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
 let msg = format!("Failed to prepare statement: {}", e);
 io::Error::other(msg)
 })?;

 let mut items: Vec<(String, Vec<u8>)> = Vec::new();
 let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

 let rows_iter = stmt
 .query_map(
 named_params! {
 ":primary_namespace": primary_namespace,
 ":secondary_namespace": secondary_namespace,
 ":key_token": page_token.0,
 ":creation_time_token": page_token.1,
 ":page_size": LIST_KEYS_MAX_PAGE_SIZE,
 },
 |row| {
 let key: String = row.get(0)?;
 let creation_time: i64 = row.get(1)?;
 let value: Vec<u8> = row.get(2)?;
 Ok((key, creation_time, value))
 },
 )
 .map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;

 let mut last_creation_time: Option<i64> = None;
 for r in rows_iter {
 let (k, ct, value) = r.map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;
 items.push((k, value));
 last_creation_time = Some(ct);
 }

 let last_key = items.last().map(|(key, _)| key.clone());
 // Match list's token behavior: EOF is confirmed by a following empty page, not by
 // withholding the token from a short non-empty page.
 let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
 Some((k, ct))
 } else {
 None
 };

 Ok(ListValuesResponse { items, next_page_token })
	}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
 all_keys
 };

 let list_all_items =
 |primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
 let mut all_items = Vec::new();
 let mut page_token = None;
 loop {
 let list_response = kv_store
 .list_values(primary_namespace, secondary_namespace, page_token)
 .unwrap();
 assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
 all_items.extend(list_response.items);
 if list_response.next_page_token.is_none() {
 break;
 }
 page_token = list_response.next_page_token;
 }
 all_items
 };

 // Test the basic KVStore operations.
 for i in 0..110 {
 kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
 assert_eq!(listed_keys.len(), 110);
 assert_eq!(listed_keys[0], testkey);

 let listed_items = list_all_items(primary_namespace, secondary_namespace);
 let listed_item_keys: Vec<String> =
 listed_items.iter().map(|(key, _)| key.clone()).collect();
 assert_eq!(listed_item_keys, listed_keys);
 for (_, value) in listed_items {
 assert_eq!(data, &*value);
 }

 let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
 assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
 assert_eq!(listed_keys.len(), 1);
 assert_eq!(listed_keys[0], max_chars);

 let listed_items = list_all_items(&max_chars, &max_chars);
 assert_eq!(listed_items.len(), 1);
 assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
 assert_eq!(data, listed_items[0].1.as_slice());

 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
 assert_eq!(data, &*read_data);
	}
Expand Down
Loading

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

Skip to content
Optimize paginated payment listing queries#240

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Optimize paginated payment listing queries
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
953b3ed

Replace SQLite pagination index


joostjager Jul 3, 2026
d4adfb5

Fix payment listing N+1 queries


joostjager Jul 3, 2026

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


19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_forwarded_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
 })?;

	let mut forwarded_payments: Vec<ForwardedPayment> =
 Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let forwarded_payment_bytes = context
 .paginated_kv_store
 .read(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read forwarded payment data: {}", e),
 )
 })?;
 Vec::with_capacity(list_response.items.len());
	for (_, forwarded_payment_bytes) in list_response.items {
 let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
 .map_err(|e| {
 LdkServerError::new(
Expand Down

19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
 LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
 })?;

	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let payment_bytes = context
 .paginated_kv_store
 .read(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read payment data: {}", e),
 )
 })?;
	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
	for (_, payment_bytes) in list_response.items {
 let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
 LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
 })?;
Expand Down

24 changes: 24 additions & 0 deletions
ldk-server/src/io/persist/paginated_kv_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
	/// `primary_namespace` and `secondary_namespace`.
	///
	/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
	#[cfg_attr(not(test), allow(dead_code))]
	fn read(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
	/// there are no more keys to return.
	///
	/// [`ListResponse`]: struct.ListResponse.html
	#[cfg_attr(not(test), allow(dead_code))]
	fn list(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListResponse, io::Error>;

	/// Returns a paginated list of keys and values that are stored under the given
	/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
	///
	/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
	/// A vector of keys, ordered in descending order of `time`.
	pub keys: Vec<String>,

	/// A token that can be used to retrieve the next set of keys.
	pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
	/// A vector of key-value pairs, ordered in descending order of `time`.
	pub items: Vec<(String, Vec<u8>)>,

	/// A token that can be used to retrieve the next set of items.
	pub next_page_token: Option<(String, i64)>,
}

115 changes: 110 additions & 5 deletions
ldk-server/src/io/persist/sqlite_store/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
 io::Error::other(msg)
 })?;

 let index_creation_time_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
 let index_paginated_kv_namespace_time_key_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
 primary_namespace,
 secondary_namespace,
 creation_time DESC,
 key ASC
 );",
 paginated_kv_table_name
 );

 connection.execute(&index_creation_time_sql, []).map_err(|e| {
 connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
 let msg = format!(
 "Failed to create index on creation_time, table {}: {}",
 "Failed to create paginated namespace index, table {}: {}",
 paginated_kv_table_name, e
 );
 io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
 Ok(Self { connection, paginated_kv_table_name })
	}

	#[cfg_attr(not(test), allow(dead_code))]
	fn read_internal(
 &self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

 Ok(ListResponse { keys, next_page_token })
	}

	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 page_token: Option<(String, i64)>,
	) -> io::Result<ListValuesResponse> {
 check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

 let locked_conn = self.connection.lock().unwrap();

 // The cursor predicate is paired with this exact ordering: newer creation times first,
 // then keys ascending to make rows with the same creation time deterministic.
 let sql = format!(
 "SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
 AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
 ORDER BY creation_time DESC, key ASC LIMIT :page_size",
 self.paginated_kv_table_name
 );

 let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
 let msg = format!("Failed to prepare statement: {}", e);
 io::Error::other(msg)
 })?;

 let mut items: Vec<(String, Vec<u8>)> = Vec::new();
 let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

 let rows_iter = stmt
 .query_map(
 named_params! {
 ":primary_namespace": primary_namespace,
 ":secondary_namespace": secondary_namespace,
 ":key_token": page_token.0,
 ":creation_time_token": page_token.1,
 ":page_size": LIST_KEYS_MAX_PAGE_SIZE,
 },
 |row| {
 let key: String = row.get(0)?;
 let creation_time: i64 = row.get(1)?;
 let value: Vec<u8> = row.get(2)?;
 Ok((key, creation_time, value))
 },
 )
 .map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;

 let mut last_creation_time: Option<i64> = None;
 for r in rows_iter {
 let (k, ct, value) = r.map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;
 items.push((k, value));
 last_creation_time = Some(ct);
 }

 let last_key = items.last().map(|(key, _)| key.clone());
 // Match list's token behavior: EOF is confirmed by a following empty page, not by
 // withholding the token from a short non-empty page.
 let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
 Some((k, ct))
 } else {
 None
 };

 Ok(ListValuesResponse { items, next_page_token })
	}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
 all_keys
 };

 let list_all_items =
 |primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
 let mut all_items = Vec::new();
 let mut page_token = None;
 loop {
 let list_response = kv_store
 .list_values(primary_namespace, secondary_namespace, page_token)
 .unwrap();
 assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
 all_items.extend(list_response.items);
 if list_response.next_page_token.is_none() {
 break;
 }
 page_token = list_response.next_page_token;
 }
 all_items
 };

 // Test the basic KVStore operations.
 for i in 0..110 {
 kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
 assert_eq!(listed_keys.len(), 110);
 assert_eq!(listed_keys[0], testkey);

 let listed_items = list_all_items(primary_namespace, secondary_namespace);
 let listed_item_keys: Vec<String> =
 listed_items.iter().map(|(key, _)| key.clone()).collect();
 assert_eq!(listed_item_keys, listed_keys);
 for (_, value) in listed_items {
 assert_eq!(data, &*value);
 }

 let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
 assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
 assert_eq!(listed_keys.len(), 1);
 assert_eq!(listed_keys[0], max_chars);

 let listed_items = list_all_items(&max_chars, &max_chars);
 assert_eq!(listed_items.len(), 1);
 assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
 assert_eq!(data, listed_items[0].1.as_slice());

 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
 assert_eq!(data, &*read_data);
	}
Expand Down
Loading

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

Skip to content
Optimize paginated payment listing queries#240

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Optimize paginated payment listing queries
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
953b3ed

Replace SQLite pagination index


joostjager Jul 3, 2026
d4adfb5

Fix payment listing N+1 queries


joostjager Jul 3, 2026

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


19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_forwarded_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
 })?;

	let mut forwarded_payments: Vec<ForwardedPayment> =
 Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let forwarded_payment_bytes = context
 .paginated_kv_store
 .read(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read forwarded payment data: {}", e),
 )
 })?;
 Vec::with_capacity(list_response.items.len());
	for (_, forwarded_payment_bytes) in list_response.items {
 let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
 .map_err(|e| {
 LdkServerError::new(
Expand Down

19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
 LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
 })?;

	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let payment_bytes = context
 .paginated_kv_store
 .read(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read payment data: {}", e),
 )
 })?;
	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
	for (_, payment_bytes) in list_response.items {
 let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
 LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
 })?;
Expand Down

24 changes: 24 additions & 0 deletions
ldk-server/src/io/persist/paginated_kv_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
	/// `primary_namespace` and `secondary_namespace`.
	///
	/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
	#[cfg_attr(not(test), allow(dead_code))]
	fn read(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
	/// there are no more keys to return.
	///
	/// [`ListResponse`]: struct.ListResponse.html
	#[cfg_attr(not(test), allow(dead_code))]
	fn list(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListResponse, io::Error>;

	/// Returns a paginated list of keys and values that are stored under the given
	/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
	///
	/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
	/// A vector of keys, ordered in descending order of `time`.
	pub keys: Vec<String>,

	/// A token that can be used to retrieve the next set of keys.
	pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
	/// A vector of key-value pairs, ordered in descending order of `time`.
	pub items: Vec<(String, Vec<u8>)>,

	/// A token that can be used to retrieve the next set of items.
	pub next_page_token: Option<(String, i64)>,
}

115 changes: 110 additions & 5 deletions
ldk-server/src/io/persist/sqlite_store/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
 io::Error::other(msg)
 })?;

 let index_creation_time_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
 let index_paginated_kv_namespace_time_key_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
 primary_namespace,
 secondary_namespace,
 creation_time DESC,
 key ASC
 );",
 paginated_kv_table_name
 );

 connection.execute(&index_creation_time_sql, []).map_err(|e| {
 connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
 let msg = format!(
 "Failed to create index on creation_time, table {}: {}",
 "Failed to create paginated namespace index, table {}: {}",
 paginated_kv_table_name, e
 );
 io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
 Ok(Self { connection, paginated_kv_table_name })
	}

	#[cfg_attr(not(test), allow(dead_code))]
	fn read_internal(
 &self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

 Ok(ListResponse { keys, next_page_token })
	}

	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 page_token: Option<(String, i64)>,
	) -> io::Result<ListValuesResponse> {
 check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

 let locked_conn = self.connection.lock().unwrap();

 // The cursor predicate is paired with this exact ordering: newer creation times first,
 // then keys ascending to make rows with the same creation time deterministic.
 let sql = format!(
 "SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
 AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
 ORDER BY creation_time DESC, key ASC LIMIT :page_size",
 self.paginated_kv_table_name
 );

 let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
 let msg = format!("Failed to prepare statement: {}", e);
 io::Error::other(msg)
 })?;

 let mut items: Vec<(String, Vec<u8>)> = Vec::new();
 let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

 let rows_iter = stmt
 .query_map(
 named_params! {
 ":primary_namespace": primary_namespace,
 ":secondary_namespace": secondary_namespace,
 ":key_token": page_token.0,
 ":creation_time_token": page_token.1,
 ":page_size": LIST_KEYS_MAX_PAGE_SIZE,
 },
 |row| {
 let key: String = row.get(0)?;
 let creation_time: i64 = row.get(1)?;
 let value: Vec<u8> = row.get(2)?;
 Ok((key, creation_time, value))
 },
 )
 .map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;

 let mut last_creation_time: Option<i64> = None;
 for r in rows_iter {
 let (k, ct, value) = r.map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;
 items.push((k, value));
 last_creation_time = Some(ct);
 }

 let last_key = items.last().map(|(key, _)| key.clone());
 // Match list's token behavior: EOF is confirmed by a following empty page, not by
 // withholding the token from a short non-empty page.
 let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
 Some((k, ct))
 } else {
 None
 };

 Ok(ListValuesResponse { items, next_page_token })
	}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
 all_keys
 };

 let list_all_items =
 |primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
 let mut all_items = Vec::new();
 let mut page_token = None;
 loop {
 let list_response = kv_store
 .list_values(primary_namespace, secondary_namespace, page_token)
 .unwrap();
 assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
 all_items.extend(list_response.items);
 if list_response.next_page_token.is_none() {
 break;
 }
 page_token = list_response.next_page_token;
 }
 all_items
 };

 // Test the basic KVStore operations.
 for i in 0..110 {
 kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
 assert_eq!(listed_keys.len(), 110);
 assert_eq!(listed_keys[0], testkey);

 let listed_items = list_all_items(primary_namespace, secondary_namespace);
 let listed_item_keys: Vec<String> =
 listed_items.iter().map(|(key, _)| key.clone()).collect();
 assert_eq!(listed_item_keys, listed_keys);
 for (_, value) in listed_items {
 assert_eq!(data, &*value);
 }

 let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
 assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
 assert_eq!(listed_keys.len(), 1);
 assert_eq!(listed_keys[0], max_chars);

 let listed_items = list_all_items(&max_chars, &max_chars);
 assert_eq!(listed_items.len(), 1);
 assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
 assert_eq!(data, listed_items[0].1.as_slice());

 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
 assert_eq!(data, &*read_data);
	}
Expand Down
Loading

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

Skip to content
Optimize paginated payment listing queries#240

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

 Closed

joostjager
wants to merge
2
commits into

from

 Closed


Optimize paginated payment listing queries
#240
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
953b3ed

Replace SQLite pagination index


joostjager Jul 3, 2026
d4adfb5

Fix payment listing N+1 queries


joostjager Jul 3, 2026

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


19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_forwarded_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,7 +28,7 @@ pub(crate) async fn handle_list_forwarded_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -41,21 +41,8 @@ pub(crate) async fn handle_list_forwarded_payments_request(
 })?;

	let mut forwarded_payments: Vec<ForwardedPayment> =
 Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let forwarded_payment_bytes = context
 .paginated_kv_store
 .read(
 FORWARDED_PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 FORWARDED_PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read forwarded payment data: {}", e),
 )
 })?;
 Vec::with_capacity(list_response.items.len());
	for (_, forwarded_payment_bytes) in list_response.items {
 let forwarded_payment = ForwardedPayment::decode(Bytes::from(forwarded_payment_bytes))
 .map_err(|e| {
 LdkServerError::new(
Expand Down

19 changes: 3 additions & 16 deletions
ldk-server/src/api/list_payments.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ pub(crate) async fn handle_list_payments_request(
	let page_token = request.page_token.map(|p| (p.token, p.index));
	let list_response = context
 .paginated_kv_store
 .list(
 .list_values(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 page_token,
Expand All@@ -36,21 +36,8 @@ pub(crate) async fn handle_list_payments_request(
 LdkServerError::new(InternalServerError, format!("Failed to list payments: {}", e))
 })?;

	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.keys.len());
	for key in list_response.keys {
 let payment_bytes = context
 .paginated_kv_store
 .read(
 PAYMENTS_PERSISTENCE_PRIMARY_NAMESPACE,
 PAYMENTS_PERSISTENCE_SECONDARY_NAMESPACE,
 &key,
 )
 .map_err(|e| {
 LdkServerError::new(
 InternalServerError,
 format!("Failed to read payment data: {}", e),
 )
 })?;
	let mut payments: Vec<Payment> = Vec::with_capacity(list_response.items.len());
	for (_, payment_bytes) in list_response.items {
 let payment = Payment::decode(Bytes::from(payment_bytes)).map_err(|e| {
 LdkServerError::new(InternalServerError, format!("Failed to decode payment: {}", e))
 })?;
Expand Down

24 changes: 24 additions & 0 deletions
ldk-server/src/io/persist/paginated_kv_store.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ pub trait PaginatedKVStore: Send + Sync {
	/// `primary_namespace` and `secondary_namespace`.
	///
	/// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
	#[cfg_attr(not(test), allow(dead_code))]
	fn read(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> Result<Vec<u8>, io::Error>;
Expand DownExpand Up@@ -74,20 +75,43 @@ pub trait PaginatedKVStore: Send + Sync {
	/// there are no more keys to return.
	///
	/// [`ListResponse`]: struct.ListResponse.html
	#[cfg_attr(not(test), allow(dead_code))]
	fn list(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListResponse, io::Error>;

	/// Returns a paginated list of keys and values that are stored under the given
	/// `secondary_namespace` in `primary_namespace`, ordered in descending order of `time`.
	///
	/// This follows the same pagination and ordering semantics as [`PaginatedKVStore::list`].
	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 next_page_token: Option<(String, i64)>,
	) -> Result<ListValuesResponse, io::Error>;
}

/// Represents the response from a paginated `list` operation.
///
/// Contains the list of keys and an optional `next_page_token` that can be used to retrieve the
/// next set of keys.
#[cfg_attr(not(test), allow(dead_code))]
pub struct ListResponse {
	/// A vector of keys, ordered in descending order of `time`.
	pub keys: Vec<String>,

	/// A token that can be used to retrieve the next set of keys.
	pub next_page_token: Option<(String, i64)>,
}

/// Represents the response from a paginated `list_values` operation.
///
/// Contains the list of keys and values and an optional `next_page_token` that can be used to
/// retrieve the next set of items.
pub struct ListValuesResponse {
	/// A vector of key-value pairs, ordered in descending order of `time`.
	pub items: Vec<(String, Vec<u8>)>,

	/// A token that can be used to retrieve the next set of items.
	pub next_page_token: Option<(String, i64)>,
}

115 changes: 110 additions & 5 deletions
ldk-server/src/io/persist/sqlite_store/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@ use std::{fs, io};
use ldk_node::lightning::types::string::PrintableString;
use rusqlite::{named_params, Connection};

use crate::io::persist::paginated_kv_store::{ListResponse, PaginatedKVStore};
use crate::io::persist::paginated_kv_store::{ListResponse, ListValuesResponse, PaginatedKVStore};
use crate::io::utils::check_namespace_key_validity;

/// The default database file name.
Expand DownExpand Up@@ -105,14 +105,19 @@ impl SqliteStore {
 io::Error::other(msg)
 })?;

 let index_creation_time_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_creation_time ON {} (creation_time);",
 let index_paginated_kv_namespace_time_key_sql = format!(
 "CREATE INDEX IF NOT EXISTS idx_paginated_kv_namespace_time_key ON {} (
 primary_namespace,
 secondary_namespace,
 creation_time DESC,
 key ASC
 );",
 paginated_kv_table_name
 );

 connection.execute(&index_creation_time_sql, []).map_err(|e| {
 connection.execute(&index_paginated_kv_namespace_time_key_sql, []).map_err(|e| {
 let msg = format!(
 "Failed to create index on creation_time, table {}: {}",
 "Failed to create paginated namespace index, table {}: {}",
 paginated_kv_table_name, e
 );
 io::Error::other(msg)
Expand All@@ -122,6 +127,7 @@ impl SqliteStore {
 Ok(Self { connection, paginated_kv_table_name })
	}

	#[cfg_attr(not(test), allow(dead_code))]
	fn read_internal(
 &self, kv_table_name: &str, primary_namespace: &str, secondary_namespace: &str, key: &str,
	) -> io::Result<Vec<u8>> {
Expand DownExpand Up@@ -285,6 +291,74 @@ impl PaginatedKVStore for SqliteStore {

 Ok(ListResponse { keys, next_page_token })
	}

	fn list_values(
 &self, primary_namespace: &str, secondary_namespace: &str,
 page_token: Option<(String, i64)>,
	) -> io::Result<ListValuesResponse> {
 check_namespace_key_validity(primary_namespace, secondary_namespace, None, "list_values")?;

 let locked_conn = self.connection.lock().unwrap();

 // The cursor predicate is paired with this exact ordering: newer creation times first,
 // then keys ascending to make rows with the same creation time deterministic.
 let sql = format!(
 "SELECT key, creation_time, value FROM {} WHERE primary_namespace=:primary_namespace AND secondary_namespace=:secondary_namespace \
 AND ( creation_time < :creation_time_token OR (creation_time = :creation_time_token AND key > :key_token) ) \
 ORDER BY creation_time DESC, key ASC LIMIT :page_size",
 self.paginated_kv_table_name
 );

 let mut stmt = locked_conn.prepare_cached(&sql).map_err(|e| {
 let msg = format!("Failed to prepare statement: {}", e);
 io::Error::other(msg)
 })?;

 let mut items: Vec<(String, Vec<u8>)> = Vec::new();
 let page_token = page_token.unwrap_or(("".to_string(), i64::MAX));

 let rows_iter = stmt
 .query_map(
 named_params! {
 ":primary_namespace": primary_namespace,
 ":secondary_namespace": secondary_namespace,
 ":key_token": page_token.0,
 ":creation_time_token": page_token.1,
 ":page_size": LIST_KEYS_MAX_PAGE_SIZE,
 },
 |row| {
 let key: String = row.get(0)?;
 let creation_time: i64 = row.get(1)?;
 let value: Vec<u8> = row.get(2)?;
 Ok((key, creation_time, value))
 },
 )
 .map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;

 let mut last_creation_time: Option<i64> = None;
 for r in rows_iter {
 let (k, ct, value) = r.map_err(|e| {
 let msg = format!("Failed to retrieve queried rows: {}", e);
 io::Error::other(msg)
 })?;
 items.push((k, value));
 last_creation_time = Some(ct);
 }

 let last_key = items.last().map(|(key, _)| key.clone());
 // Match list's token behavior: EOF is confirmed by a following empty page, not by
 // withholding the token from a short non-empty page.
 let next_page_token = if let (Some(k), Some(ct)) = (last_key, last_creation_time) {
 Some((k, ct))
 } else {
 None
 };

 Ok(ListValuesResponse { items, next_page_token })
	}
}

#[cfg(test)]
Expand DownExpand Up@@ -343,6 +417,24 @@ mod tests {
 all_keys
 };

 let list_all_items =
 |primary_namespace: &str, secondary_namespace: &str| -> Vec<(String, Vec<u8>)> {
 let mut all_items = Vec::new();
 let mut page_token = None;
 loop {
 let list_response = kv_store
 .list_values(primary_namespace, secondary_namespace, page_token)
 .unwrap();
 assert!(list_response.items.len() <= LIST_KEYS_MAX_PAGE_SIZE as usize);
 all_items.extend(list_response.items);
 if list_response.next_page_token.is_none() {
 break;
 }
 page_token = list_response.next_page_token;
 }
 all_items
 };

 // Test the basic KVStore operations.
 for i in 0..110 {
 kv_store
Expand All@@ -365,6 +457,14 @@ mod tests {
 assert_eq!(listed_keys.len(), 110);
 assert_eq!(listed_keys[0], testkey);

 let listed_items = list_all_items(primary_namespace, secondary_namespace);
 let listed_item_keys: Vec<String> =
 listed_items.iter().map(|(key, _)| key.clone()).collect();
 assert_eq!(listed_item_keys, listed_keys);
 for (_, value) in listed_items {
 assert_eq!(data, &*value);
 }

 let read_data = kv_store.read(primary_namespace, secondary_namespace, testkey).unwrap();
 assert_eq!(data, &*read_data);

Expand All@@ -378,6 +478,11 @@ mod tests {
 assert_eq!(listed_keys.len(), 1);
 assert_eq!(listed_keys[0], max_chars);

 let listed_items = list_all_items(&max_chars, &max_chars);
 assert_eq!(listed_items.len(), 1);
 assert_eq!(listed_items[0].0.as_str(), max_chars.as_str());
 assert_eq!(data, listed_items[0].1.as_slice());

 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
 assert_eq!(data, &*read_data);
	}
Expand Down
Loading