Skip to content

Derive shutdown scripts without blocking on wallet persistence #1011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jkczyz wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Derive shutdown scripts without blocking on wallet persistence #1011

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
273e4d0
Derive shutdown scripts without blocking on wallet persistence
jkczyz Jul 30, 2026
1b27621
f - Pool pre-persisted addresses instead of deferring the reveal's pe…
jkczyz Aug 6, 2026
338dc8f
f - Serve user-facing address requests from the address pool
jkczyz Aug 7, 2026
6ed64e8
f - Abort in-flight address pool refills at shutdown
jkczyz Aug 7, 2026
075a40c
f - Account for the address pool in full-scan stop gaps
jkczyz Aug 7, 2026
97df7cf
f - Keep failed refills from durably revealing unrecorded indices
jkczyz Aug 10, 2026
77164dc
f - Drop the address pool full-scan stop-gap extension
jkczyz Aug 10, 2026
5fd08ef
f - Read the address pool record alongside the other startup reads
jkczyz Aug 10, 2026
a7c52af
f - Reinsert failed handouts into the address pool by index
jkczyz Aug 10, 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
7 changes: 7 additions & 0 deletions src/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1754,6 +1754,13 @@ fn build_with_store_internal(
Arc::clone(&pending_payment_store),
));

// Fill the address pool up front so LDK's sync `SignerProvider` callbacks can hand out
// pre-persisted addresses without waiting on wallet persistence.
runtime.block_on(wallet.initialize_address_pool()).map_err(|e| {

@tnull tnull Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to parallelize the reads on startup.

IMO it would also preferable to keep up the pre-existing patterns of doing the read_ methods here in parallel, and then hand that in to initialize via an AddressPool::new or so rather than doing all/obfuscating in an initialize_ method.

@jkczyz jkczyz Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Done. The record read now runs in the tokio::join! with the other startup reads, its result is handed to Wallet::new, which validates it in AddressPool::new, and the builder only blocks on the initial pool top-up. One side effect: a failed read now fails the build with ReadFailed rather than WalletSetupFailed.

log_error!(logger, "Failed to initialize the wallet's address pool: {}", e);
BuildError::WalletSetupFailed
})?;

tx_broadcaster.set_wallet(Arc::downgrade(&wallet));

// Initialize the KeysManager
Expand Down
5 changes: 5 additions & 0 deletions src/io/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@ pub(crate) const BDK_WALLET_INDEXER_PRIMARY_NAMESPACE: &str = "bdk_wallet";
pub(crate) const BDK_WALLET_INDEXER_SECONDARY_NAMESPACE: &str = "";
pub(crate) const BDK_WALLET_INDEXER_KEY: &str = "indexer";

/// The derivation indices of the wallet's address pool will be persisted under this key.
pub(crate) const BDK_WALLET_ADDRESS_POOL_PRIMARY_NAMESPACE: &str = "bdk_wallet";
pub(crate) const BDK_WALLET_ADDRESS_POOL_SECONDARY_NAMESPACE: &str = "";
pub(crate) const BDK_WALLET_ADDRESS_POOL_KEY: &str = "address_pool";

/// [`StaticInvoice`]s will be persisted under this key.
///
/// [`StaticInvoice`]: lightning::offers::static_invoice::StaticInvoice
Expand Down
Loading