Skip to content

Add populate_anchor_cache method to bdk #2005

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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
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
15 changes: 15 additions & 0 deletions crates/electrum/src/bdk_electrum_client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use bdk_core::{
BlockId, CheckPoint, ConfirmationBlockTime, TxUpdate,
};
use electrum_client::{ElectrumApi, Error, HeaderNotification};
use std::convert::TryInto;
use std::sync::{Arc, Mutex};

/// We include a chain suffix of a certain length for the purpose of robustness.
Expand Down Expand Up @@ -37,6 +38,20 @@ impl<E: ElectrumApi> BdkElectrumClient<E> {
}
}

/// Insert anchors into the anchor cache so that they don’t have to be fetched again from
/// Electrum. Typically used to pre-populate the cache from an existing `TxGraph`.
pub fn populate_anchor_cache(
&self,
tx_anchors: impl IntoIterator<Item = (Txid, impl IntoIterator<Item = ConfirmationBlockTime>)>,
) {
let mut cache = self.anchor_cache.lock().unwrap();
for (txid, anchors) in tx_anchors {
for anchor in anchors {
cache.insert((txid, anchor.block_id.hash), anchor);
}
}
}

/// Inserts transactions into the transaction cache so that the client will not fetch these
/// transactions.
pub fn populate_tx_cache(&self, txs: impl IntoIterator<Item = impl Into<Arc<Transaction>>>) {
Expand Down
7 changes: 6 additions & 1 deletion examples/example_electrum/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,12 @@ fn main() -> anyhow::Result<()> {
};

let client = BdkElectrumClient::new(electrum_cmd.electrum_args().client(network)?);

{
// Lock graph mutex - released automatically at scope end
// Cache all anchors while holding the lock
let graph = graph.lock().unwrap();
client.populate_anchor_cache(graph.graph().all_anchors().clone());
}
// Tell the electrum client about the txs we've already got locally so it doesn't re-download
// them
client.populate_tx_cache(
Expand Down