Skip to content

Async persistence (explore only) #793

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

Draft
joostjager wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Async persistence (explore only) #793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2f8867e
Use async ChainMonitor persister via new_async_beta
joostjager Feb 11, 2026
24423ea
Convert write_node_metrics to async KVStore
joostjager Feb 16, 2026
1979468
Convert DataStore persistence to async KVStore
joostjager Feb 16, 2026
89c261c
Convert PeerStore persistence to async KVStore
joostjager Feb 16, 2026
fdc28b8
Convert StaticInvoiceStore persistence to async KVStore
joostjager Feb 16, 2026
8219c17
Convert BDK wallet persistence to AsyncWalletPersister
joostjager Feb 16, 2026
5d60790
Convert export_pathfinding_scores to async KVStore
joostjager Feb 16, 2026
fcfe2d9
Remove KVStoreSync from core traits and store implementations
joostjager Feb 16, 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
11 changes: 5 additions & 6 deletions benches/payments.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,10 @@ fn spawn_payment(node_a: Arc<Node>, node_b: Arc<Node>, amount_msat: u64) {
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
}

let payment_id = node_a.spontaneous_payment().send_with_preimage(
amount_msat,
node_b.node_id(),
preimage,
None,
);
let payment_id = node_a
.spontaneous_payment()
.send_with_preimage(amount_msat, node_b.node_id(), preimage, None)
.await;

match payment_id {
Ok(payment_id) => {
Expand Down Expand Up @@ -110,6 +108,7 @@ async fn send_payments(node_a: Arc<Node>, node_b: Arc<Node>) -> std::time::Durat
PaymentPreimage(preimage_bytes),
None,
)
.await
.ok()
.unwrap();

Expand Down
66 changes: 33 additions & 33 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,28 +164,28 @@ interface Node {
OnchainPayment onchain_payment();
UnifiedPayment unified_payment();
LSPS1Liquidity lsps1_liquidity();
[Throws=NodeError]
[Throws=NodeError, Async]
void connect(PublicKey node_id, SocketAddress address, boolean persist);
[Throws=NodeError]
[Throws=NodeError, Async]
void disconnect(PublicKey node_id);
[Throws=NodeError]
[Throws=NodeError, Async]
UserChannelId open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Throws=NodeError, Async]
UserChannelId open_announced_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
[Throws=NodeError]
[Throws=NodeError, Async]
void splice_in([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, u64 splice_amount_sats);
[Throws=NodeError]
[Throws=NodeError, Async]
void splice_out([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, [ByRef]Address address, u64 splice_amount_sats);
[Throws=NodeError]
[Throws=NodeError, Async]
void close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);
[Throws=NodeError]
[Throws=NodeError, Async]
void force_close_channel([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, string? reason);
[Throws=NodeError]
void update_channel_config([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, ChannelConfig channel_config);
[Throws=NodeError]
void sync_wallets();
PaymentDetails? payment([ByRef]PaymentId payment_id);
[Throws=NodeError]
[Throws=NodeError, Async]
void remove_payment([ByRef]PaymentId payment_id);
BalanceDetails list_balances();
sequence<PaymentDetails> list_payments();
Expand All @@ -194,7 +194,7 @@ interface Node {
NetworkGraph network_graph();
string sign_message([ByRef]sequence<u8> msg);
boolean verify_signature([ByRef]sequence<u8> msg, [ByRef]string sig, [ByRef]PublicKey pkey);
[Throws=NodeError]
[Async, Throws=NodeError]
bytes export_pathfinding_scores();
};

Expand All @@ -205,48 +205,48 @@ interface Bolt11InvoiceDescription {
};

interface Bolt11Payment {
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send([ByRef]Bolt11Invoice invoice, RouteParametersConfig? route_parameters);
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
[Throws=NodeError]
void send_probes([ByRef]Bolt11Invoice invoice, RouteParametersConfig? route_parameters);
[Throws=NodeError]
void send_probes_using_amount([ByRef]Bolt11Invoice invoice, u64 amount_msat, RouteParametersConfig? route_parameters);
[Throws=NodeError]
void claim_for_hash(PaymentHash payment_hash, u64 claimable_amount_msat, PaymentPreimage preimage);
[Throws=NodeError]
[Throws=NodeError, Async]
void fail_for_hash(PaymentHash payment_hash);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive_for_hash(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs, PaymentHash payment_hash);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive_variable_amount([ByRef]Bolt11InvoiceDescription description, u32 expiry_secs);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive_variable_amount_for_hash([ByRef]Bolt11InvoiceDescription description, u32 expiry_secs, PaymentHash payment_hash);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive_via_jit_channel(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs, u64? max_lsp_fee_limit_msat);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive_via_jit_channel_for_hash(u64 amount_msat, [ByRef]Bolt11InvoiceDescription description, u32 expiry_secs, u64? max_lsp_fee_limit_msat, PaymentHash payment_hash);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive_variable_amount_via_jit_channel([ByRef]Bolt11InvoiceDescription description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt11Invoice receive_variable_amount_via_jit_channel_for_hash([ByRef]Bolt11InvoiceDescription description, u32 expiry_secs, u64? max_proportional_lsp_fee_limit_ppm_msat, PaymentHash payment_hash);
};

interface Bolt12Payment {
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send([ByRef]Offer offer, u64? quantity, string? payer_note, RouteParametersConfig? route_parameters);
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send_using_amount([ByRef]Offer offer, u64 amount_msat, u64? quantity, string? payer_note, RouteParametersConfig? route_parameters);
[Throws=NodeError]
Offer receive(u64 amount_msat, [ByRef]string description, u32? expiry_secs, u64? quantity);
[Throws=NodeError]
Offer receive_variable_amount([ByRef]string description, u32? expiry_secs);
[Throws=NodeError]
[Throws=NodeError, Async]
Bolt12Invoice request_refund_payment([ByRef]Refund refund);
[Throws=NodeError]
[Throws=NodeError, Async]
Refund initiate_refund(u64 amount_msat, u32 expiry_secs, u64? quantity, string? payer_note, RouteParametersConfig? route_parameters);
[Throws=NodeError]
Offer receive_async();
Expand All @@ -257,24 +257,24 @@ interface Bolt12Payment {
};

interface SpontaneousPayment {
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send(u64 amount_msat, PublicKey node_id, RouteParametersConfig? route_parameters);
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send_with_custom_tlvs(u64 amount_msat, PublicKey node_id, RouteParametersConfig? route_parameters, sequence<CustomTlvRecord> custom_tlvs);
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send_with_preimage(u64 amount_msat, PublicKey node_id, PaymentPreimage preimage, RouteParametersConfig? route_parameters);
[Throws=NodeError]
[Throws=NodeError, Async]
PaymentId send_with_preimage_and_custom_tlvs(u64 amount_msat, PublicKey node_id, sequence<CustomTlvRecord> custom_tlvs, PaymentPreimage preimage, RouteParametersConfig? route_parameters);
[Throws=NodeError]
void send_probes(u64 amount_msat, PublicKey node_id);
};

interface OnchainPayment {
[Throws=NodeError]
[Throws=NodeError, Async]
Address new_address();
[Throws=NodeError]
[Throws=NodeError, Async]
Txid send_to_address([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate);
[Throws=NodeError]
[Throws=NodeError, Async]
Txid send_all_to_address([ByRef]Address address, boolean retain_reserve, FeeRate? fee_rate);
};

Expand All @@ -289,7 +289,7 @@ interface FeeRate {
};

interface UnifiedPayment {
[Throws=NodeError]
[Throws=NodeError, Async]
string receive(u64 amount_sats, [ByRef]string message, u32 expiry_sec);
[Throws=NodeError, Async]
UnifiedPaymentResult send([ByRef]string uri_str, u64? amount_msat, RouteParametersConfig? route_parameters);
Expand Down
77 changes: 40 additions & 37 deletions src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ use crate::peer_store::PeerStore;
use crate::runtime::{Runtime, RuntimeSpawner};
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreWrapper, GossipSync, Graph,
KeysManager, MessageRouter, OnionMessenger, PaymentStore, PeerManager, PendingPaymentStore,
Persister, SyncAndAsyncKVStore,
AsyncPersister, ChainMonitor, ChannelManager, DynStore, DynStoreRef, DynStoreWrapper,
GossipSync, Graph, KeysManager, MessageRouter, OnionMessenger, PaymentStore, PeerManager,
PendingPaymentStore,
};
use crate::wallet::persist::KVStoreWalletPersister;
use crate::wallet::Wallet;
Expand Down Expand Up @@ -169,17 +169,17 @@ pub enum BuildError {
RuntimeSetupFailed,
/// We failed to read data from the [`KVStore`].
///
/// [`KVStore`]: lightning::util::persist::KVStoreSync
/// [`KVStore`]: lightning::util::persist::KVStore
ReadFailed,
/// We failed to write data to the [`KVStore`].
///
/// [`KVStore`]: lightning::util::persist::KVStoreSync
/// [`KVStore`]: lightning::util::persist::KVStore
WriteFailed,
/// We failed to access the given `storage_dir_path`.
StoragePathAccessFailed,
/// We failed to setup our [`KVStore`].
///
/// [`KVStore`]: lightning::util::persist::KVStoreSync
/// [`KVStore`]: lightning::util::persist::KVStore
KVStoreSetupFailed,
/// We failed to setup the onchain wallet.
WalletSetupFailed,
Expand Down Expand Up @@ -655,7 +655,7 @@ impl NodeBuilder {
}

/// Builds a [`Node`] instance according to the options previously configured.
pub fn build_with_store<S: SyncAndAsyncKVStore + Send + Sync + 'static>(
pub fn build_with_store<S: KVStore + Send + Sync + 'static>(
&self, node_entropy: NodeEntropy, kv_store: S,
) -> Result<Node, BuildError> {
let logger = setup_logger(&self.log_writer_config, &self.config)?;
Expand Down Expand Up @@ -1020,7 +1020,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
// Note that the generics here don't actually work for Uniffi, but we don't currently expose
// this so its not needed.
pub fn build_with_store<S: SyncAndAsyncKVStore + Send + Sync + 'static>(
pub fn build_with_store<S: KVStore + Send + Sync + 'static>(
&self, node_entropy: Arc<NodeEntropy>, kv_store: S,
) -> Result<Arc<Node>, BuildError> {
self.inner.read().unwrap().build_with_store(*node_entropy, kv_store).map(Arc::new)
Expand Down Expand Up @@ -1193,12 +1193,15 @@ fn build_with_store_internal(
let change_descriptor = Bip84(xprv, KeychainKind::Internal);
let mut wallet_persister =
KVStoreWalletPersister::new(Arc::clone(&kv_store), Arc::clone(&logger));
let wallet_opt = BdkWallet::load()
.descriptor(KeychainKind::External, Some(descriptor.clone()))
.descriptor(KeychainKind::Internal, Some(change_descriptor.clone()))
.extract_keys()
.check_network(config.network)
.load_wallet(&mut wallet_persister)
let wallet_opt = runtime
.block_on(
BdkWallet::load()
.descriptor(KeychainKind::External, Some(descriptor.clone()))
.descriptor(KeychainKind::Internal, Some(change_descriptor.clone()))
.extract_keys()
.check_network(config.network)
.load_wallet_async(&mut wallet_persister),
)
.map_err(|e| match e {
bdk_wallet::LoadWithPersistError::InvalidChangeSet(
bdk_wallet::LoadError::Mismatch(bdk_wallet::LoadMismatch::Network {
Expand All @@ -1222,9 +1225,12 @@ fn build_with_store_internal(
let bdk_wallet = match wallet_opt {
Some(wallet) => wallet,
None => {
let mut wallet = BdkWallet::create(descriptor, change_descriptor)
.network(config.network)
.create_wallet(&mut wallet_persister)
let mut wallet = runtime
.block_on(
BdkWallet::create(descriptor, change_descriptor)
.network(config.network)
.create_wallet_async(&mut wallet_persister),
)
.map_err(|e| {
log_error!(logger, "Failed to set up wallet: {}", e);
BuildError::WalletSetupFailed
Expand Down Expand Up @@ -1289,8 +1295,8 @@ fn build_with_store_internal(
));

let peer_storage_key = keys_manager.get_peer_storage_key();
let monitor_reader = Arc::new(AsyncPersister::new(
Arc::clone(&kv_store),
let persister = Arc::new(AsyncPersister::new(
DynStoreRef(Arc::clone(&kv_store)),
RuntimeSpawner::new(Arc::clone(&runtime)),
Arc::clone(&logger),
PERSISTER_MAX_PENDING_UPDATES,
Expand All @@ -1303,9 +1309,9 @@ fn build_with_store_internal(
// Read ChannelMonitors and the NetworkGraph
let kv_store_ref = Arc::clone(&kv_store);
let logger_ref = Arc::clone(&logger);
let (monitor_read_res, network_graph_res) = runtime.block_on(async move {
let (monitor_read_res, network_graph_res) = runtime.block_on(async {
tokio::join!(
monitor_reader.read_all_channel_monitors_with_updates_parallel(),
persister.read_all_channel_monitors_with_updates_parallel(),
read_network_graph(&*kv_store_ref, logger_ref),
)
});
Expand All @@ -1323,23 +1329,16 @@ fn build_with_store_internal(
},
};

let persister = Arc::new(Persister::new(
Arc::clone(&kv_store),
Arc::clone(&logger),
PERSISTER_MAX_PENDING_UPDATES,
Arc::clone(&keys_manager),
Arc::clone(&keys_manager),
Arc::clone(&tx_broadcaster),
Arc::clone(&fee_estimator),
));
let persister = Arc::try_unwrap(persister)
.unwrap_or_else(|_| panic!("Arc<AsyncPersister> should have no other references"));

// Initialize the ChainMonitor
let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new_async_beta(
Some(Arc::clone(&chain_source)),
Arc::clone(&tx_broadcaster),
Arc::clone(&logger),
Arc::clone(&fee_estimator),
Arc::clone(&persister),
persister,
Arc::clone(&keys_manager),
peer_storage_key,
));
Expand Down Expand Up @@ -1565,12 +1564,16 @@ fn build_with_store_internal(
{
let mut locked_node_metrics = node_metrics.write().unwrap();
locked_node_metrics.latest_rgs_snapshot_timestamp = None;
write_node_metrics(&*locked_node_metrics, &*kv_store, Arc::clone(&logger))
.map_err(|e| {
log_error!(logger, "Failed writing to store: {}", e);
BuildError::WriteFailed
})?;
}
runtime
.block_on(async {
let snapshot = node_metrics.read().unwrap().clone();
write_node_metrics(&snapshot, &*kv_store, Arc::clone(&logger)).await
})
.map_err(|e| {
log_error!(logger, "Failed writing to store: {}", e);
BuildError::WriteFailed
})?;
p2p_source
},
GossipSourceConfig::RapidGossipSync(rgs_server) => {
Expand Down
Loading
Loading