Skip to content

Add docs for EsploraAsyncExt and make doctests runnable #889

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

Merged
evanlinjin merged 1 commit into from
Mar 17, 2023
Merged

Add docs for EsploraAsyncExt and make doctests runnable #889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion crates/bdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ To persist the `Wallet` on disk, `Wallet` needs to be constructed with a

**Example**

```rust,no_run
```rust
use bdk::{bitcoin::Network, wallet::{AddressIndex, Wallet}};

fn main() {
Expand Down
9 changes: 3 additions & 6 deletions crates/esplora/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,12 @@ For async-only (with https):
bdk_esplora = { version = "0.1", features = ["async-https"] }
```

To use the extension trait:

```rust,no_run
To use the extension traits:
```rust
// for blocking
use bdk_esplora::EsploraExt;
// for async
use bdk_esplora::EsploraAsyncExt;
```

<!-- BDK Esplora client library for updating the `bdk_chain` structures. -->

<!-- [`esplora_client`]: https://docs.rs/esplora-client/latest -->
For full examples, refer to [`example-crates/wallet_esplora`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora) (blocking) and [`example-crates/wallet_esplora_async`](https://github.com/bitcoindevkit/bdk/tree/master/example-crates/wallet_esplora_async).
7 changes: 7 additions & 0 deletions crates/esplora/src/async_ext.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ use futures::stream::{FuturesOrdered, TryStreamExt};

use crate::map_confirmation_time;

/// Trait to extend [`esplora_client::AsyncClient`] functionality.
///
/// This is the async version of [`EsploraExt`]. Refer to
/// [crate-level documentation] for more.
///
/// [`EsploraExt`]: crate::EsploraExt
/// [crate-level documentation]: crate
#[cfg(feature = "async")]
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
Expand Down