Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.66 KB

README.md

File metadata and controls

53 lines (41 loc) · 1.66 KB

BDK Esplora

BDK Esplora extends esplora-client (with extension traits: EsploraExt and EsploraAsyncExt) to update bdk_chain structures from an Esplora server.

The extension traits are primarily intended to satisfy SyncRequests with sync and FullScanRequests with full_scan.

Usage

For blocking-only:

bdk_esplora = { version = "0.19", features = ["blocking"] }

For async-only:

bdk_esplora = { version = "0.19", features = ["async"] }

For async-only (with https):

You can additionally specify to use either rustls or native-tls, e.g. async-https-native, and this applies to both async and blocking features.

bdk_esplora = { version = "0.19", features = ["async-https"] }

For async-only (with tokio):

bdk_esplora = { version = "0.19", features = ["async", "tokio"] }

To use the extension traits:

// for blocking
#[cfg(feature = "blocking")]
use bdk_esplora::EsploraExt;

// for async
#[cfg(feature = "async")]
use bdk_esplora::EsploraAsyncExt;

For full examples, refer to example_wallet_esplora_blocking and example_wallet_esplora_async.