Skip to content

Commit b5b9224

Browse files
committed
Rename esplora features to -async and -blocking
1 parent cf2bc38 commit b5b9224

File tree

4 files changed

+20
-17
lines changed

4 files changed

+20
-17
lines changed

.github/workflows/cont_integration.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ jobs:
1717
- default
1818
- minimal
1919
- all-keys
20-
- minimal,use-esplora-ureq
20+
- minimal,use-esplora-blocking
2121
- key-value-db
2222
- electrum
2323
- compact_filters
24-
- esplora,ureq,key-value-db,electrum
24+
- use-esplora-blocking,key-value-db,electrum
2525
- compiler
2626
- rpc
2727
- verify
2828
- async-interface
29-
- use-esplora-reqwest
29+
- use-esplora-async
3030
- sqlite
3131
- sqlite-bundled
3232
steps:
@@ -100,10 +100,10 @@ jobs:
100100
features: test-rpc-legacy
101101
- name: esplora
102102
testprefix: esplora
103-
features: test-esplora,use-esplora-reqwest,verify
103+
features: test-esplora,use-esplora-async,verify
104104
- name: esplora
105105
testprefix: esplora
106-
features: test-esplora,use-esplora-ureq,verify
106+
features: test-esplora,use-esplora-blocking,verify
107107
steps:
108108
- name: Checkout
109109
uses: actions/checkout@v2
@@ -154,7 +154,7 @@ jobs:
154154
- name: Update toolchain
155155
run: rustup update
156156
- name: Check
157-
run: cargo check --target wasm32-unknown-unknown --features use-esplora-reqwest --no-default-features
157+
run: cargo check --target wasm32-unknown-unknown --features use-esplora-async --no-default-features
158158

159159
fmt:
160160
name: Rust fmt

.github/workflows/nightly_docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
- name: Update toolchain
2525
run: rustup update
2626
- name: Build docs
27-
run: cargo rustdoc --verbose --features=compiler,electrum,esplora,ureq,compact_filters,key-value-db,all-keys,sqlite -- --cfg docsrs -Dwarnings
27+
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
2828
- name: Upload artifact
2929
uses: actions/upload-artifact@v2
3030
with:

Cargo.toml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,22 +68,25 @@ hardware-signer = ["hwi"]
6868
#
6969
# - Users wanting asynchronous HTTP calls should enable `async-interface` to get
7070
# access to the asynchronous method implementations. Then, if Esplora is wanted,
71-
# enable `esplora` AND `reqwest` (`--features=use-esplora-reqwest`).
71+
# enable the `use-esplora-async` feature.
7272
# - Users wanting blocking HTTP calls can use any of the other blockchain
7373
# implementations (`compact_filters`, `electrum`, or `esplora`). Users wanting to
74-
# use Esplora should enable `esplora` AND `ureq` (`--features=use-esplora-ureq`).
74+
# use Esplora should enable the `use-esplora-blocking` feature.
7575
#
7676
# WARNING: Please take care with the features below, various combinations will
7777
# fail to build. We cannot currently build `bdk` with `--all-features`.
7878
async-interface = ["async-trait"]
7979
electrum = ["electrum-client"]
8080
# MUST ALSO USE `--no-default-features`.
81-
use-esplora-reqwest = ["esplora", "esplora-client/async", "futures"]
82-
use-esplora-ureq = ["esplora", "esplora-client/blocking"]
81+
use-esplora-async = ["esplora", "esplora-client/async", "futures"]
82+
use-esplora-blocking = ["esplora", "esplora-client/blocking"]
83+
# Deprecated aliases
84+
use-esplora-reqwest = ["use-esplora-async"]
85+
use-esplora-ureq = ["use-esplora-blocking"]
8386
# Typical configurations will not need to use `esplora` feature directly.
8487
esplora = []
8588

86-
# Use below feature with `use-esplora-reqwest` to enable reqwest default TLS support
89+
# Use below feature with `use-esplora-async` to enable reqwest default TLS support
8790
reqwest-default-tls = ["esplora-client/async-https"]
8891

8992
# Debug/Test features
@@ -128,6 +131,6 @@ required-features = ["electrum"]
128131
[workspace]
129132
members = ["macros"]
130133
[package.metadata.docs.rs]
131-
features = ["compiler", "electrum", "esplora", "use-esplora-ureq", "compact_filters", "rpc", "key-value-db", "sqlite", "all-keys", "verify", "hardware-signer"]
134+
features = ["compiler", "electrum", "esplora", "use-esplora-blocking", "compact_filters", "rpc", "key-value-db", "sqlite", "all-keys", "verify", "hardware-signer"]
132135
# defines the configuration attribute `docsrs`
133136
rustdoc-args = ["--cfg", "docsrs"]

src/blockchain/esplora/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@
2020
2121
pub use esplora_client::Error as EsploraError;
2222

23-
#[cfg(feature = "use-esplora-reqwest")]
23+
#[cfg(feature = "use-esplora-async")]
2424
mod reqwest;
2525

26-
#[cfg(feature = "use-esplora-reqwest")]
26+
#[cfg(feature = "use-esplora-async")]
2727
pub use self::reqwest::*;
2828

29-
#[cfg(feature = "use-esplora-ureq")]
29+
#[cfg(feature = "use-esplora-blocking")]
3030
mod ureq;
3131

32-
#[cfg(feature = "use-esplora-ureq")]
32+
#[cfg(feature = "use-esplora-blocking")]
3333
pub use self::ureq::*;
3434

3535
/// Configuration for an [`EsploraBlockchain`]

0 commit comments

Comments
 (0)