|
| 1 | +use bdk_chain::bitcoin::{Address, Amount, ScriptBuf}; |
| 2 | +use bdk_core::{ |
| 3 | + bitcoin::{ |
| 4 | + consensus::WriteExt, |
| 5 | + hashes::Hash, |
| 6 | + key::{Secp256k1, UntweakedPublicKey}, |
| 7 | + Network, TapNodeHash, |
| 8 | + }, |
| 9 | + spk_client::SyncRequest, |
| 10 | + CheckPoint, |
| 11 | +}; |
| 12 | +use bdk_electrum::BdkElectrumClient; |
| 13 | +use bdk_testenv::{anyhow, bitcoincore_rpc::RpcApi, TestEnv}; |
| 14 | +use criterion::{criterion_group, criterion_main, Criterion}; |
| 15 | +use electrum_client::ElectrumApi; |
| 16 | +use std::{collections::BTreeSet, time::Duration}; |
| 17 | + |
| 18 | +// Batch size for `sync_with_electrum`. |
| 19 | +const BATCH_SIZE: usize = 100; |
| 20 | + |
| 21 | +pub fn get_test_spk(i: usize) -> ScriptBuf { |
| 22 | + const PK_BYTES: &[u8] = &[ |
| 23 | + 12, 244, 72, 4, 163, 4, 211, 81, 159, 82, 153, 123, 125, 74, 142, 40, 55, 237, 191, 231, |
| 24 | + 31, 114, 89, 165, 83, 141, 8, 203, 93, 240, 53, 101, |
| 25 | + ]; |
| 26 | + let secp = Secp256k1::new(); |
| 27 | + let pk = UntweakedPublicKey::from_slice(PK_BYTES).expect("Must be valid PK"); |
| 28 | + let mut engine = TapNodeHash::engine(); |
| 29 | + engine.emit_u64(i as u64).expect("must emit"); |
| 30 | + ScriptBuf::new_p2tr(&secp, pk, Some(TapNodeHash::from_engine(engine))) |
| 31 | +} |
| 32 | + |
| 33 | +fn sync_with_electrum<E: ElectrumApi>( |
| 34 | + client: &BdkElectrumClient<E>, |
| 35 | + spks: &[ScriptBuf], |
| 36 | + chain_tip: &CheckPoint, |
| 37 | +) -> anyhow::Result<()> { |
| 38 | + let update = client.sync( |
| 39 | + SyncRequest::builder() |
| 40 | + .chain_tip(chain_tip.clone()) |
| 41 | + .spks(spks.iter().cloned()), |
| 42 | + BATCH_SIZE, |
| 43 | + true, |
| 44 | + )?; |
| 45 | + |
| 46 | + assert!( |
| 47 | + !update.tx_update.txs.is_empty(), |
| 48 | + "expected some transactions from sync, but got none" |
| 49 | + ); |
| 50 | + |
| 51 | + Ok(()) |
| 52 | +} |
| 53 | + |
| 54 | +pub fn test_sync_performance(c: &mut Criterion) { |
| 55 | + let env = TestEnv::new().unwrap(); |
| 56 | + |
| 57 | + const NUM_BLOCKS: usize = 100; |
| 58 | + let mut spks = Vec::with_capacity(NUM_BLOCKS); |
| 59 | + |
| 60 | + // Mine some blocks and send transactions. |
| 61 | + env.mine_blocks(101, None).unwrap(); |
| 62 | + |
| 63 | + // Scatter UTXOs across many blocks. |
| 64 | + for i in 0..NUM_BLOCKS { |
| 65 | + let spk = get_test_spk(i); |
| 66 | + let addr = Address::from_script(&spk, Network::Regtest).unwrap(); |
| 67 | + env.send(&addr, Amount::from_sat(10_000)).unwrap(); |
| 68 | + env.mine_blocks(1, None).unwrap(); |
| 69 | + |
| 70 | + spks.push(spk); |
| 71 | + } |
| 72 | + let _ = env.wait_until_electrum_sees_block(Duration::from_secs(6)); |
| 73 | + assert_eq!( |
| 74 | + spks.iter().cloned().collect::<BTreeSet<_>>().len(), |
| 75 | + spks.len(), |
| 76 | + "all spks must be unique", |
| 77 | + ); |
| 78 | + |
| 79 | + // Setup receiver. |
| 80 | + let genesis_cp = CheckPoint::new(bdk_core::BlockId { |
| 81 | + height: 0, |
| 82 | + hash: env.bitcoind.client.get_block_hash(0).unwrap(), |
| 83 | + }); |
| 84 | + |
| 85 | + { |
| 86 | + let electrum_client = |
| 87 | + electrum_client::Client::new(env.electrsd.electrum_url.as_str()).unwrap(); |
| 88 | + let spks = spks.clone(); |
| 89 | + let genesis_cp = genesis_cp.clone(); |
| 90 | + c.bench_function("sync_with_electrum", move |b| { |
| 91 | + b.iter(|| { |
| 92 | + sync_with_electrum( |
| 93 | + &BdkElectrumClient::new(&electrum_client), |
| 94 | + &spks, |
| 95 | + &genesis_cp, |
| 96 | + ) |
| 97 | + .expect("must not error") |
| 98 | + }) |
| 99 | + }); |
| 100 | + } |
| 101 | + |
| 102 | + { |
| 103 | + let client = BdkElectrumClient::new( |
| 104 | + electrum_client::Client::new(env.electrsd.electrum_url.as_str()).unwrap(), |
| 105 | + ); |
| 106 | + c.bench_function("sync_with_electrum_cached", move |b| { |
| 107 | + b.iter(|| sync_with_electrum(&client, &spks, &genesis_cp).expect("must not error")) |
| 108 | + }); |
| 109 | + } |
| 110 | +} |
| 111 | + |
| 112 | +criterion_group! { |
| 113 | + name = benches; |
| 114 | + config = Criterion::default() |
| 115 | + .sample_size(10); |
| 116 | + targets = test_sync_performance |
| 117 | +} |
| 118 | +criterion_main!(benches); |
0 commit comments