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"

lib.rs:

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.