Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Parallelize Cashu cache loading by benthecarman · Pull Request #94 · lightningdevkit/orange-sdk · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Parallelize Cashu cache loading by benthecarman · Pull Request #94 · lightningdevkit/orange-sdk · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Parallelize Cashu cache loading by benthecarman · Pull Request #94 · lightningdevkit/orange-sdk · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Parallelize Cashu cache loading by benthecarman · Pull Request #94 · lightningdevkit/orange-sdk · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Parallelize Cashu cache loading by benthecarman · Pull Request #94 · lightningdevkit/orange-sdk · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Parallelize Cashu cache loading by benthecarman · Pull Request #94 · lightningdevkit/orange-sdk · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Parallelize Cashu cache loading by benthecarman · Pull Request #94 · lightningdevkit/orange-sdk · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
174 changes: 174 additions & 0 deletions orange-sdk/src/dyn_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,11 @@ use std::sync::Arc;

use ldk_node::lightning::io;
use ldk_node::lightning::util::persist::KVStore;
use tokio::task::JoinSet;

/// Matches the connection capacity used by the VSS HTTP client. Keeping the
/// limit here also prevents large wallets from spawning one task per record.
const MAX_CONCURRENT_READS: usize = 10;

/// Object-safe view of a `KVStore` backend. Async methods return boxed futures so the trait
/// can be used through `dyn`.
Expand DownExpand Up@@ -119,3 +124,172 @@ impl KVStore for LdkNodeStore {
self.0.list_async(p, s)
}
}

/// Reads a set of keys concurrently while preserving the input order.
///
/// Storage formats expose record collections as a list followed by individual
/// reads. For a remote store, performing those reads serially adds one network
/// round trip per record. This helper bounds that fan-out to the VSS connection
/// pool size and retains the same fail-fast I/O behavior as a serial loop.
pub(crate) async fn read_keys_bounded(
store: Arc<dyn DynStore>, primary_namespace: &str, secondary_namespace: &str, keys: Vec<String>,
) -> Result<Vec<(String, Vec<u8>)>, io::Error> {
if keys.is_empty() {
return Ok(Vec::new());
}

type ReadResult = (usize, String, Result<Vec<u8>, io::Error>);

let primary_namespace = primary_namespace.to_owned();
let secondary_namespace = secondary_namespace.to_owned();
let mut pending = keys.into_iter().enumerate();
let mut reads: JoinSet<ReadResult> = JoinSet::new();
let mut results = Vec::with_capacity(pending.len());
results.resize_with(pending.len(), || None);

let spawn_read = |reads: &mut JoinSet<ReadResult>, index, key: String| {
let store = Arc::clone(&store);
let primary_namespace = primary_namespace.clone();
let secondary_namespace = secondary_namespace.clone();
reads.spawn(async move {
let data = store.read_async(&primary_namespace, &secondary_namespace, &key).await;
(index, key, data)
});
};

for _ in 0..MAX_CONCURRENT_READS {
if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
} else {
break;
}
}

while let Some(result) = reads.join_next().await {
let (index, key, data) = result.map_err(|e| {
io::Error::new(io::ErrorKind::Other, format!("store read task failed: {e}"))
})?;
results[index] = Some((key, data?));

if let Some((index, key)) = pending.next() {
spawn_read(&mut reads, index, key);
}
}

Ok(results
.into_iter()
.map(|result| result.expect("every bounded store read must complete"))
.collect())
}

#[cfg(test)]
mod tests {
use super::*;
use std::future::ready;
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::{Semaphore, mpsc};

struct ControlledStore {
entered: mpsc::UnboundedSender<String>,
release: Arc<Semaphore>,
active: Arc<AtomicUsize>,
max_active: Arc<AtomicUsize>,
fail_key: Option<String>,
}

impl KVStore for ControlledStore {
fn read(
&self, _primary_namespace: &str, _secondary_namespace: &str, key: &str,
) -> impl Future<Output = Result<Vec<u8>, io::Error>> + Send + 'static {
let key = key.to_owned();
let entered = self.entered.clone();
let release = Arc::clone(&self.release);
let active = Arc::clone(&self.active);
let max_active = Arc::clone(&self.max_active);
let should_fail = self.fail_key.as_ref() == Some(&key);
async move {
let active_count = active.fetch_add(1, Ordering::SeqCst) + 1;
max_active.fetch_max(active_count, Ordering::SeqCst);
let _ = entered.send(key.clone());
let _permit =
release.acquire_owned().await.expect("test semaphore must remain open");
active.fetch_sub(1, Ordering::SeqCst);

if should_fail {
Err(io::Error::new(io::ErrorKind::InvalidData, "controlled read failure"))
} else {
Ok(key.into_bytes())
}
}
}

fn write(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _buf: Vec<u8>,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn remove(
&self, _primary_namespace: &str, _secondary_namespace: &str, _key: &str, _lazy: bool,
) -> impl Future<Output = Result<(), io::Error>> + Send + 'static {
ready(Ok(()))
}

fn list(
&self, _primary_namespace: &str, _secondary_namespace: &str,
) -> impl Future<Output = Result<Vec<String>, io::Error>> + Send + 'static {
ready(Ok(Vec::new()))
}
}

#[tokio::test]
async fn bounded_reads_limit_concurrency_and_preserve_order() {
let (entered, mut entered_rx) = mpsc::unbounded_channel();
let release = Arc::new(Semaphore::new(0));
let max_active = Arc::new(AtomicUsize::new(0));
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::clone(&release),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::clone(&max_active),
fail_key: None,
});
let keys: Vec<_> = (0..12).rev().map(|index| format!("key-{index:02}")).collect();

let reads = tokio::spawn(read_keys_bounded(store, "primary", "secondary", keys.clone()));
for _ in 0..MAX_CONCURRENT_READS {
entered_rx.recv().await.expect("bounded read must start");
}
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
assert!(entered_rx.try_recv().is_err());

release.add_permits(keys.len());
let records = reads.await.unwrap().unwrap();
let result_keys: Vec<_> = records.iter().map(|(key, _)| key.clone()).collect();
assert_eq!(result_keys, keys);
assert!(records.iter().all(|(key, data)| key.as_bytes() == data));
assert_eq!(max_active.load(Ordering::SeqCst), MAX_CONCURRENT_READS);
}

#[tokio::test]
async fn bounded_reads_propagate_store_errors() {
let (entered, _entered_rx) = mpsc::unbounded_channel();
let store: Arc<dyn DynStore> = Arc::new(ControlledStore {
entered,
release: Arc::new(Semaphore::new(2)),
active: Arc::new(AtomicUsize::new(0)),
max_active: Arc::new(AtomicUsize::new(0)),
fail_key: Some("bad".to_owned()),
});

let error = read_keys_bounded(
store,
"primary",
"secondary",
vec!["good".to_owned(), "bad".to_owned()],
)
.await
.unwrap_err();
assert_eq!(error.kind(), io::ErrorKind::InvalidData);
}
}
12 changes: 6 additions & 6 deletions orange-sdk/src/store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use bitcoin_payment_instructions::amount::Amount;

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use ldk_node::bitcoin::Txid;
use ldk_node::bitcoin::hex::{DisplayHex, FromHex};
use ldk_node::lightning::io;
Expand DownExpand Up@@ -458,11 +458,11 @@ impl TxMetadataStore {
.await
.expect("We do not allow reads to fail");
let mut tx_metadata = HashMap::with_capacity(keys.len());
for key in keys {
let data_bytes =
KVStore::read(store.as_ref(), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, &key)
.await
.expect("We do not allow reads to fail");
let records =
read_keys_bounded(Arc::clone(&store), STORE_PRIMARY_KEY, STORE_SECONDARY_KEY, keys)
.await
.expect("We do not allow reads to fail");
for (key, data_bytes) in records {
let key =
PaymentId::from_str(&key).expect("Invalid key in transaction metadata storage");
let data = Readable::read(&mut &data_bytes[..])
Expand Down
21 changes: 13 additions & 8 deletions orange-sdk/src/trusted_wallet/cashu/cashu_store.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ use std::fmt::Debug;
use std::str::FromStr;
use std::sync::{Arc, RwLock};

use crate::dyn_store::DynStore;
use crate::dyn_store::{DynStore, read_keys_bounded};
use async_trait::async_trait;
use cdk::cdk_database::WalletDatabase;
use cdk::wallet::types::WalletSaga;
Expand DownExpand Up@@ -180,15 +180,20 @@ impl CashuKvDatabase {
}

async fn load_caches(&self) -> Result<(), DatabaseError> {
// Load mints cache
if let Ok(mints) = self.load_mints_from_store().await {
// These use independent namespaces and can be restored concurrently. This
// lets remote stores pipeline the requests while synchronous stores retain
// their existing behavior.
let (mints, proofs) =
tokio::join!(self.load_mints_from_store(), self.load_proofs_from_store());

if let Ok(mints) = mints {
let mut cache = self.mints_cache.write().unwrap();
*cache = mints;
}

// Proof errors must not be hidden: presenting an empty cache for an unreadable
// proof set could make the wallet report an incorrect balance.
let proofs = self.load_proofs_from_store().await?;
let proofs = proofs?;
let mut cache = self.proofs_cache.write().unwrap();
*cache = proofs;

Expand DownExpand Up@@ -641,12 +646,12 @@ impl WalletDatabase<cdk::cdk_database::Error> for CashuKvDatabase {
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(keys.len());
for key in keys {
let data = KVStore::read(self.store.as_ref(), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, &key)
let records =
read_keys_bounded(Arc::clone(&self.store), CASHU_PRIMARY_KEY, MINT_QUOTES_KEY, keys)
.await
.map_err(DatabaseError::Io)?;

let mut quotes = Vec::with_capacity(records.len());
for (_, data) in records {
if !data.is_empty() {
let quote: MintQuote = serde_json::from_slice(&data)
.map_err(|e| DatabaseError::Serialization(e.to_string()))?;
Expand Down