Rename esplora features to -async and -blocking

This commit is contained in:
Alekos Filini 2022-09-28 19:33:22 +02:00
parent cf2bc388f2
commit b5b92248c7
No known key found for this signature in database
GPG Key ID: 431401E4A4530061
4 changed files with 20 additions and 17 deletions

View File

@ -17,16 +17,16 @@ jobs:
- default - default
- minimal - minimal
- all-keys - all-keys
- minimal,use-esplora-ureq - minimal,use-esplora-blocking
- key-value-db - key-value-db
- electrum - electrum
- compact_filters - compact_filters
- esplora,ureq,key-value-db,electrum - use-esplora-blocking,key-value-db,electrum
- compiler - compiler
- rpc - rpc
- verify - verify
- async-interface - async-interface
- use-esplora-reqwest - use-esplora-async
- sqlite - sqlite
- sqlite-bundled - sqlite-bundled
steps: steps:
@ -100,10 +100,10 @@ jobs:
features: test-rpc-legacy features: test-rpc-legacy
- name: esplora - name: esplora
testprefix: esplora testprefix: esplora
features: test-esplora,use-esplora-reqwest,verify features: test-esplora,use-esplora-async,verify
- name: esplora - name: esplora
testprefix: esplora testprefix: esplora
features: test-esplora,use-esplora-ureq,verify features: test-esplora,use-esplora-blocking,verify
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v2
@ -154,7 +154,7 @@ jobs:
- name: Update toolchain - name: Update toolchain
run: rustup update run: rustup update
- name: Check - name: Check
run: cargo check --target wasm32-unknown-unknown --features use-esplora-reqwest --no-default-features run: cargo check --target wasm32-unknown-unknown --features use-esplora-async --no-default-features
fmt: fmt:
name: Rust fmt name: Rust fmt

View File

@ -24,7 +24,7 @@ jobs:
- name: Update toolchain - name: Update toolchain
run: rustup update run: rustup update
- name: Build docs - name: Build docs
run: cargo rustdoc --verbose --features=compiler,electrum,esplora,ureq,compact_filters,key-value-db,all-keys,sqlite -- --cfg docsrs -Dwarnings run: cargo rustdoc --verbose --features=compiler,electrum,esplora,use-esplora-blocking,compact_filters,rpc,key-value-db,sqlite,all-keys,verify,hardware-signer -- --cfg docsrs -Dwarnings
- name: Upload artifact - name: Upload artifact
uses: actions/upload-artifact@v2 uses: actions/upload-artifact@v2
with: with:

View File

@ -68,22 +68,25 @@ hardware-signer = ["hwi"]
# #
# - Users wanting asynchronous HTTP calls should enable `async-interface` to get # - Users wanting asynchronous HTTP calls should enable `async-interface` to get
# access to the asynchronous method implementations. Then, if Esplora is wanted, # access to the asynchronous method implementations. Then, if Esplora is wanted,
# enable `esplora` AND `reqwest` (`--features=use-esplora-reqwest`). # enable the `use-esplora-async` feature.
# - Users wanting blocking HTTP calls can use any of the other blockchain # - Users wanting blocking HTTP calls can use any of the other blockchain
# implementations (`compact_filters`, `electrum`, or `esplora`). Users wanting to # implementations (`compact_filters`, `electrum`, or `esplora`). Users wanting to
# use Esplora should enable `esplora` AND `ureq` (`--features=use-esplora-ureq`). # use Esplora should enable the `use-esplora-blocking` feature.
# #
# WARNING: Please take care with the features below, various combinations will # WARNING: Please take care with the features below, various combinations will
# fail to build. We cannot currently build `bdk` with `--all-features`. # fail to build. We cannot currently build `bdk` with `--all-features`.
async-interface = ["async-trait"] async-interface = ["async-trait"]
electrum = ["electrum-client"] electrum = ["electrum-client"]
# MUST ALSO USE `--no-default-features`. # MUST ALSO USE `--no-default-features`.
use-esplora-reqwest = ["esplora", "esplora-client/async", "futures"] use-esplora-async = ["esplora", "esplora-client/async", "futures"]
use-esplora-ureq = ["esplora", "esplora-client/blocking"] use-esplora-blocking = ["esplora", "esplora-client/blocking"]
# Deprecated aliases
use-esplora-reqwest = ["use-esplora-async"]
use-esplora-ureq = ["use-esplora-blocking"]
# Typical configurations will not need to use `esplora` feature directly. # Typical configurations will not need to use `esplora` feature directly.
esplora = [] esplora = []
# Use below feature with `use-esplora-reqwest` to enable reqwest default TLS support # Use below feature with `use-esplora-async` to enable reqwest default TLS support
reqwest-default-tls = ["esplora-client/async-https"] reqwest-default-tls = ["esplora-client/async-https"]
# Debug/Test features # Debug/Test features
@ -128,6 +131,6 @@ required-features = ["electrum"]
[workspace] [workspace]
members = ["macros"] members = ["macros"]
[package.metadata.docs.rs] [package.metadata.docs.rs]
features = ["compiler", "electrum", "esplora", "use-esplora-ureq", "compact_filters", "rpc", "key-value-db", "sqlite", "all-keys", "verify", "hardware-signer"] features = ["compiler", "electrum", "esplora", "use-esplora-blocking", "compact_filters", "rpc", "key-value-db", "sqlite", "all-keys", "verify", "hardware-signer"]
# defines the configuration attribute `docsrs` # defines the configuration attribute `docsrs`
rustdoc-args = ["--cfg", "docsrs"] rustdoc-args = ["--cfg", "docsrs"]

View File

@ -20,16 +20,16 @@
pub use esplora_client::Error as EsploraError; pub use esplora_client::Error as EsploraError;
#[cfg(feature = "use-esplora-reqwest")] #[cfg(feature = "use-esplora-async")]
mod reqwest; mod reqwest;
#[cfg(feature = "use-esplora-reqwest")] #[cfg(feature = "use-esplora-async")]
pub use self::reqwest::*; pub use self::reqwest::*;
#[cfg(feature = "use-esplora-ureq")] #[cfg(feature = "use-esplora-blocking")]
mod ureq; mod ureq;
#[cfg(feature = "use-esplora-ureq")] #[cfg(feature = "use-esplora-blocking")]
pub use self::ureq::*; pub use self::ureq::*;
/// Configuration for an [`EsploraBlockchain`] /// Configuration for an [`EsploraBlockchain`]