Skip to content

Sync a Wallet with Esplora

Add required bdk dependencies to your Cargo.toml file

Cargo.toml
1
2
3
4
[dependencies]
bdk_wallet = { version = "1.0.0" }
bdk_esplora = { version = "0.20.1", features = ["blocking"] }
anyhow = "1"

Create and sync the wallet

main.rs
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
use anyhow::Error;
use bdk_esplora::esplora_client::Builder;
use bdk_esplora::{esplora_client, EsploraExt};
use bdk_wallet::bitcoin::Network;
use bdk_wallet::chain::spk_client::{
    FullScanRequestBuilder, FullScanResponse, SyncRequestBuilder, SyncResponse,
};
use bdk_wallet::AddressInfo;
use bdk_wallet::KeychainKind;
use bdk_wallet::Wallet;

const STOP_GAP: usize = 50;
const PARALLEL_REQUESTS: usize = 1;
const EXTERNAL_DESCRIPTOR: &str = "tr(tprv8ZgxMBicQKsPdrjwWCyXqqJ4YqcyG4DmKtjjsRt29v1PtD3r3PuFJAjWytzcvSTKnZAGAkPSmnrdnuHWxCAwy3i1iPhrtKAfXRH7dVCNGp6/86'/1'/0'/0/*)#g9xn7wf9";
const INTERNAL_DESCRIPTOR: &str = "tr(tprv8ZgxMBicQKsPdrjwWCyXqqJ4YqcyG4DmKtjjsRt29v1PtD3r3PuFJAjWytzcvSTKnZAGAkPSmnrdnuHWxCAwy3i1iPhrtKAfXRH7dVCNGp6/86'/1'/0'/1/*)#e3rjrmea";

fn main() -> Result<(), Error> {
    let mut wallet: Wallet = Wallet::create(EXTERNAL_DESCRIPTOR, INTERNAL_DESCRIPTOR)
        .network(Network::Signet)
        .create_wallet_no_persist()?;

    let address: AddressInfo = wallet.reveal_next_address(KeychainKind::External);
    println!(
        "Generated address {} at index {}",
        address.address, address.index
    );

    //--8<-- [start:client]
    // Create the Esplora client
    let client: esplora_client::BlockingClient =
        Builder::new("http://signet.bitcoindevkit.net").build_blocking();
    //--8<-- [end:client]

    //--8<-- [start:scan]
    // Full scan the wallet
    let full_scan_request: FullScanRequestBuilder<KeychainKind> = wallet.start_full_scan();
    let full_scan_response: FullScanResponse<KeychainKind> =
        client.full_scan(full_scan_request, STOP_GAP, PARALLEL_REQUESTS)?;

    // Apply the full scan response to the wallet
    wallet.apply_update(full_scan_response)?;
    //--8<-- [end:scan]

    //--8<-- [start:sync]
    // Sync the wallet
    let sync_request: SyncRequestBuilder<(KeychainKind, u32)> =
        wallet.start_sync_with_revealed_spks();
    let sync_response: SyncResponse = client.sync(sync_request, PARALLEL_REQUESTS)?;

    // Apply the sync response to the wallet
    wallet.apply_update(sync_response)?;
    //--8<-- [end:sync]

    let balance = wallet.balance();
    println!("Wallet balance: {} sat", balance.total().to_sat());

    Ok(())
}