22 breaking releases

0.23.0 May 27, 2025
0.21.0 Feb 5, 2025
0.20.1 Dec 19, 2024
0.19.0 Oct 2, 2024
0.2.0 Mar 20, 2023

#3 in #electrum

Download history 2365/week @ 2025-02-28 3698/week @ 2025-03-07 2362/week @ 2025-03-14 3440/week @ 2025-03-21 2147/week @ 2025-03-28 2055/week @ 2025-04-04 2021/week @ 2025-04-11 4343/week @ 2025-04-18 3916/week @ 2025-04-25 2635/week @ 2025-05-02 2822/week @ 2025-05-09 2613/week @ 2025-05-16 4354/week @ 2025-05-23 3138/week @ 2025-05-30 3215/week @ 2025-06-06 2587/week @ 2025-06-13

13,908 downloads per month
Used in 4 crates

MIT/Apache

73KB
1K SLoC

This crate is used for returning updates from Electrum servers.

Updates are returned as either a SyncResponse (if [BdkElectrumClient::sync()] is called), or a FullScanResponse (if [BdkElectrumClient::full_scan()] is called).

In most cases [BdkElectrumClient::sync()] is used to sync the transaction histories of scripts that the application cares about, for example the scripts for all the receive addresses of a Wallet's keychain that it has shown a user.

BdkElectrumClient::full_scan is meant to be used when importing or restoring a keychain where the range of possibly used scripts is not known. In this case it is necessary to scan all keychain scripts until a number (the "stop gap") of unused scripts is discovered.

Refer to example_electrum for a complete example.


BDK Electrum

BDK Electrum extends electrum-client to update bdk_chain structures from an Electrum server.

Minimum Supported Rust Version (MSRV)

This crate has a MSRV of 1.75.0.

To build with MSRV you will need to pin dependencies as follows:

cargo update -p home --precise "0.5.9"

Dependencies

~7–19MB
~210K SLoC