More documentation improvements

This commit is contained in:
志宇
2023-03-10 13:40:27 +13:00
parent ae9b19d84c
commit 5dd4ce74cf
5 changed files with 50 additions and 6 deletions

View File

@@ -1,3 +1,36 @@
# BDK Esplora
BDK Esplora client library for updating the `bdk_chain` structures.
BDK Esplora extends [`esplora_client`](crate::esplora_client) to update [`bdk_chain`] structures
from an Esplora server.
## Usage
There are two versions of the extension trait (blocking and async).
For blocking-only:
```toml
bdk_esplora = { version = "0.1", features = ["blocking"] }
```
For async-only:
```toml
bdk_esplora = { version = "0.1", features = ["async"] }
```
For async-only (with https):
```toml
bdk_esplora = { version = "0.1", features = ["async-https"] }
```
To use the extension trait:
```rust,no_run
// 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 -->

View File

@@ -1,8 +1,4 @@
//! This crate is used for updating structures of [`bdk_chain`] with data from an esplora server.
//!
//! The star of the show is the [`EsploraExt::scan`] method which scans for relevant
//! blockchain data (via esplora) and outputs a [`KeychainScan`](bdk_chain::keychain::KeychainScan).
#![doc = include_str!("../README.md")]
use bdk_chain::ConfirmationTime;
use esplora_client::TxStatus;