Skip to content

Commit

Permalink
refactor: rename methods in EsploraExt and EsploraExtAsync
Browse files Browse the repository at this point in the history
  • Loading branch information
vladimirfomene committed Sep 12, 2023
1 parent 2867e88 commit 2090021
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 21 deletions.
12 changes: 6 additions & 6 deletions crates/esplora/src/async_ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ pub trait EsploraAsyncExt {
/// transactions. `parallel_requests` specifies the max number of HTTP requests to make in
/// parallel.
#[allow(clippy::result_large_err)]
async fn update_tx_graph<K: Ord + Clone + Send>(
async fn scan_txs_with_keychains<K: Ord + Clone + Send>(
&self,
keychain_spks: BTreeMap<
K,
Expand All @@ -60,18 +60,18 @@ pub trait EsploraAsyncExt {
parallel_requests: usize,
) -> Result<(TxGraph<ConfirmationTimeAnchor>, BTreeMap<K, u32>), Error>;

/// Convenience method to call [`update_tx_graph`] without requiring a keychain.
/// Convenience method to call [`scan_txs_with_keychains`] without requiring a keychain.
///
/// [`update_tx_graph`]: EsploraAsyncExt::update_tx_graph
/// [`scan_txs_with_keychains`]: EsploraAsyncExt::scan_txs_with_keychains
#[allow(clippy::result_large_err)]
async fn update_tx_graph_without_keychain(
async fn scan_txs(
&self,
misc_spks: impl IntoIterator<IntoIter = impl Iterator<Item = ScriptBuf> + Send> + Send,
txids: impl IntoIterator<IntoIter = impl Iterator<Item = Txid> + Send> + Send,
outpoints: impl IntoIterator<IntoIter = impl Iterator<Item = OutPoint> + Send> + Send,
parallel_requests: usize,
) -> Result<TxGraph<ConfirmationTimeAnchor>, Error> {
self.update_tx_graph(
self.scan_txs_with_keychains(
[(
(),
misc_spks
Expand Down Expand Up @@ -201,7 +201,7 @@ impl EsploraAsyncExt for esplora_client::AsyncClient {
})
}

async fn update_tx_graph<K: Ord + Clone + Send>(
async fn scan_txs_with_keychains<K: Ord + Clone + Send>(
&self,
keychain_spks: BTreeMap<
K,
Expand Down
12 changes: 6 additions & 6 deletions crates/esplora/src/blocking_ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ pub trait EsploraExt {
/// transactions. `parallel_requests` specifies the max number of HTTP requests to make in
/// parallel.
#[allow(clippy::result_large_err)]
fn update_tx_graph<K: Ord + Clone>(
fn scan_txs_with_keychains<K: Ord + Clone>(
&self,
keychain_spks: BTreeMap<K, impl IntoIterator<Item = (u32, ScriptBuf)>>,
txids: impl IntoIterator<Item = Txid>,
Expand All @@ -55,18 +55,18 @@ pub trait EsploraExt {
parallel_requests: usize,
) -> Result<(TxGraph<ConfirmationTimeAnchor>, BTreeMap<K, u32>), Error>;

/// Convenience method to call [`update_tx_graph`] without requiring a keychain.
/// Convenience method to call [`scan_txs_with_keychains`] without requiring a keychain.
///
/// [`update_tx_graph`]: EsploraExt::update_tx_graph
/// [`scan_txs_with_keychains`]: EsploraExt::scan_txs_with_keychains
#[allow(clippy::result_large_err)]
fn update_tx_graph_without_keychain(
fn scan_txs(
&self,
misc_spks: impl IntoIterator<Item = ScriptBuf>,
txids: impl IntoIterator<Item = Txid>,
outpoints: impl IntoIterator<Item = OutPoint>,
parallel_requests: usize,
) -> Result<TxGraph<ConfirmationTimeAnchor>, Error> {
self.update_tx_graph(
self.scan_txs_with_keychains(
[(
(),
misc_spks
Expand Down Expand Up @@ -192,7 +192,7 @@ impl EsploraExt for esplora_client::BlockingClient {
})
}

fn update_tx_graph<K: Ord + Clone>(
fn scan_txs_with_keychains<K: Ord + Clone>(
&self,
keychain_spks: BTreeMap<K, impl IntoIterator<Item = (u32, ScriptBuf)>>,
txids: impl IntoIterator<Item = Txid>,
Expand Down
10 changes: 3 additions & 7 deletions example-crates/example_esplora/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ fn main() -> anyhow::Result<()> {
// represents the last active spk derivation indices of keychains
// (`keychain_indices_update`).
let (graph_update, last_active_indices) = client
.update_tx_graph(
.scan_txs_with_keychains(
keychain_spks,
core::iter::empty(),
core::iter::empty(),
Expand Down Expand Up @@ -276,12 +276,8 @@ fn main() -> anyhow::Result<()> {
}
}

let graph_update = client.update_tx_graph_without_keychain(
spks,
txids,
outpoints,
scan_options.parallel_requests,
)?;
let graph_update =
client.scan_txs(spks, txids, outpoints, scan_options.parallel_requests)?;

graph.lock().unwrap().apply_update(graph_update)
}
Expand Down
2 changes: 1 addition & 1 deletion example-crates/wallet_esplora_async/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
})
.collect();
let (update_graph, last_active_indices) = client
.update_tx_graph(keychain_spks, None, None, STOP_GAP, PARALLEL_REQUESTS)
.scan_txs_with_keychains(keychain_spks, None, None, STOP_GAP, PARALLEL_REQUESTS)
.await?;
let missing_heights = wallet.tx_graph().missing_heights(wallet.local_chain());
let chain_update = client.update_local_chain(prev_tip, missing_heights).await?;
Expand Down
2 changes: 1 addition & 1 deletion example-crates/wallet_esplora_blocking/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
.collect();

let (update_graph, last_active_indices) =
client.update_tx_graph(keychain_spks, None, None, STOP_GAP, PARALLEL_REQUESTS)?;
client.scan_txs_with_keychains(keychain_spks, None, None, STOP_GAP, PARALLEL_REQUESTS)?;
let missing_heights = wallet.tx_graph().missing_heights(wallet.local_chain());
let chain_update = client.update_local_chain(prev_tip, missing_heights)?;
let update = WalletUpdate {
Expand Down

0 comments on commit 2090021

Please sign in to comment.