bdk_electrum 0.24.0

use bdk_chain::bitcoin::{Address, Amount, ScriptBuf};
use bdk_core::{
    bitcoin::{
        consensus::WriteExt,
        hashes::Hash,
        key::{Secp256k1, UntweakedPublicKey},
        Network, TapNodeHash,
    },
    spk_client::SyncRequest,
    CheckPoint,
};
use bdk_electrum::BdkElectrumClient;
use bdk_testenv::{anyhow, bitcoincore_rpc::RpcApi, TestEnv};
use criterion::{criterion_group, criterion_main, Criterion};
use electrum_client::ElectrumApi;
use std::{collections::BTreeSet, time::Duration};

// Batch size for `sync_with_electrum`.
const BATCH_SIZE: usize = 100;

pub fn get_test_spk(i: usize) -> ScriptBuf {
    const PK_BYTES: &[u8] = &[
        12, 244, 72, 4, 163, 4, 211, 81, 159, 82, 153, 123, 125, 74, 142, 40, 55, 237, 191, 231,
        31, 114, 89, 165, 83, 141, 8, 203, 93, 240, 53, 101,
    ];
    let secp = Secp256k1::new();
    let pk = UntweakedPublicKey::from_slice(PK_BYTES).expect("Must be valid PK");
    let mut engine = TapNodeHash::engine();
    engine.emit_u64(i as u64).expect("must emit");
    ScriptBuf::new_p2tr(&secp, pk, Some(TapNodeHash::from_engine(engine)))
}

fn sync_with_electrum<E: ElectrumApi>(
    client: &BdkElectrumClient<E>,
    spks: &[ScriptBuf],
    chain_tip: &CheckPoint,
) -> anyhow::Result<()> {
    let update = client.sync(
        SyncRequest::builder()
            .chain_tip(chain_tip.clone())
            .spks(spks.iter().cloned()),
        BATCH_SIZE,
        true,
    )?;

    assert!(
        !update.tx_update.txs.is_empty(),
        "expected some transactions from sync, but got none"
    );

    Ok(())
}

pub fn test_sync_performance(c: &mut Criterion) {
    let env = TestEnv::new().unwrap();

    const NUM_BLOCKS: usize = 100;
    let mut spks = Vec::with_capacity(NUM_BLOCKS);

    // Mine some blocks and send transactions.
    env.mine_blocks(101, None).unwrap();

    // Scatter UTXOs across many blocks.
    for i in 0..NUM_BLOCKS {
        let spk = get_test_spk(i);
        let addr = Address::from_script(&spk, Network::Regtest).unwrap();
        env.send(&addr, Amount::from_sat(10_000)).unwrap();
        env.mine_blocks(1, None).unwrap();

        spks.push(spk);
    }
    let _ = env.wait_until_electrum_sees_block(Duration::from_secs(6));
    assert_eq!(
        spks.iter().cloned().collect::<BTreeSet<_>>().len(),
        spks.len(),
        "all spks must be unique",
    );

    // Setup receiver.
    let genesis_cp = CheckPoint::new(bdk_core::BlockId {
        height: 0,
        hash: env.bitcoind.client.get_block_hash(0).unwrap(),
    });

    {
        let electrum_client =
            electrum_client::Client::new(env.electrsd.electrum_url.as_str()).unwrap();
        let spks = spks.clone();
        let genesis_cp = genesis_cp.clone();
        c.bench_function("sync_with_electrum", move |b| {
            b.iter(|| {
                sync_with_electrum(
                    &BdkElectrumClient::new(&electrum_client),
                    &spks,
                    &genesis_cp,
                )
                .expect("must not error")
            })
        });
    }

    {
        let client = BdkElectrumClient::new(
            electrum_client::Client::new(env.electrsd.electrum_url.as_str()).unwrap(),
        );
        c.bench_function("sync_with_electrum_cached", move |b| {
            b.iter(|| sync_with_electrum(&client, &spks, &genesis_cp).expect("must not error"))
        });
    }
}

criterion_group! {
    name = benches;
    config = Criterion::default()
        .sample_size(10);
    targets = test_sync_performance
}
criterion_main!(benches);