diff --git a/Cargo.lock b/Cargo.lock index ab6631d..7d86ac4 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -94,7 +94,7 @@ dependencies = [ [[package]] name = "bdk_electrum_streaming" -version = "0.6.0" +version = "0.7.0" dependencies = [ "anyhow", "bdk_chain", diff --git a/bdk_electrum_streaming/Cargo.toml b/bdk_electrum_streaming/Cargo.toml index d353c61..45021b4 100644 --- a/bdk_electrum_streaming/Cargo.toml +++ b/bdk_electrum_streaming/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "bdk_electrum_streaming" -version = "0.6.0" -description = "Experimental but sane BDK electrum client by @evanlinjin." +version = "0.7.0" +description = "An async/blocking Electrum client for BDK, built as an explicit streaming state machine." license = "MIT OR Apache-2.0" edition = "2021" rust-version = "1.70" diff --git a/bdk_electrum_streaming/README.md b/bdk_electrum_streaming/README.md index d558859..296d96a 100644 --- a/bdk_electrum_streaming/README.md +++ b/bdk_electrum_streaming/README.md @@ -1,3 +1,8 @@ -# Experimental BDK Electrum +# bdk_electrum_streaming -Redo `bdk_electrum` using `e_electrum_client`. +An async/blocking Electrum client for [BDK](https://bitcoindevkit.org), built as an explicit +state machine on top of [`electrum_streaming_client`](https://docs.rs/electrum_streaming_client). + +Tracks a set of descriptors, subscribes to their script hashes, and streams `FullScanResponse` +updates as history, transactions and anchors resolve, instead of blocking until an entire scan +completes. Handles reorgs by refetching whichever anchors they affect.