21 breaking releases

new 0.22.0 May 1, 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

#686 in Magic Beans

Download history 632/week @ 2025-01-11 948/week @ 2025-01-18 932/week @ 2025-01-25 1849/week @ 2025-02-01 831/week @ 2025-02-08 1817/week @ 2025-02-15 3148/week @ 2025-02-22 2162/week @ 2025-03-01 3810/week @ 2025-03-08 2246/week @ 2025-03-15 3404/week @ 2025-03-22 2316/week @ 2025-03-29 1661/week @ 2025-04-05 2768/week @ 2025-04-12 4453/week @ 2025-04-19 2903/week @ 2025-04-26

12,301 downloads per month
Used in 3 crates

MIT/Apache

68KB
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–17MB
~204K SLoC