Merge pull request #110 from sdmg15/feat/cbf-data-source

feat: integrate compact block filter

Author: ChrisSon15

Cargo.lock

@@ -10,6 +10,7 @@ bdk_electrum = { version = "0.23.2", default-features = false, features = ["use-
 rustls = { version = "0.23.35", default-features = false, features = ["ring", "std", "tls12", "logging"] }
 # v2.2.0 deprecates `bdk_wallet::wallet::signer` without making it clear what alternative to use & how:
 bdk_wallet = { version = "~2.1.0", features = ["rusqlite", "keys-bip39"] }
+bdk_kyoto = "0.15.3"
 const_format = "0.2.35"
 rusqlite = { version = "0.31.0", features = ["bundled-sqlcipher"] }
 
@@ -23,6 +24,8 @@ base64 = "0.22.1"
 hex = "0.4"
 zeroize = "1.8.1"
 argon2 = { version = "0.5.3", default-features = false }
+tracing = "0.1"
+tracing-subscriber = "0.3"
 
 [workspace.lints.rust]
 rust-2024-compatibility = "warn"

Cargo.toml

@@ -1,23 +1,24 @@
+use std::net::SocketAddrV4;
+use std::sync::Arc;
+use std::time::Duration;
+
 /// Bitcoin regtest environment using electrsd with automatic executable downloads
 use anyhow::{Context, Result};
 use bdk_electrum::bdk_core::bitcoin::{KnownHrp, XOnlyPublicKey};
 use bdk_electrum::BdkElectrumClient;
-
-
+use bdk_wallet::bitcoin::address::NetworkChecked;
 use bdk_wallet::bitcoin::key::Secp256k1;
 use bdk_wallet::bitcoin::secp256k1::All;
-use bdk_wallet::bitcoin::{address::NetworkChecked, Address, Amount, BlockHash, Network, Transaction, Txid};
+use bdk_wallet::bitcoin::{Address, Amount, BlockHash, Network, Transaction, Txid};
 use corepc_node::get_available_port;
-use electrsd::corepc_node;
-use electrsd::electrum_client::Client;
-use electrsd::{corepc_node::Node, electrum_client::ElectrumApi, ElectrsD};
+use electrsd::corepc_node::Node;
+use electrsd::electrum_client::{Client, ElectrumApi};
+use electrsd::{corepc_node, ElectrsD};
 use hmac::{Hmac, Mac};
 use rand::{Rng, RngCore};
 use secp::Scalar;
 use sha2::Sha256;
 use simple_semaphore::{Permit, Semaphore};
-use std::sync::Arc;
-use std::time::Duration;
 use tempfile::{tempdir, TempDir};
 
 
@@ -54,6 +55,7 @@ impl Default for Config<'_> {
                 let mut conf = corepc_node::Conf::default();
                 // Listen on all interfaces (0.0.0.0) instead of just localhost
                 conf.args.push("-rpcbind=0.0.0.0");
+                conf.args.push("-listen=1");
 
                 // Allow connections from any IP (use 0.0.0.0/0 for "everywhere")
                 conf.args.push("-rpcallowip=0.0.0.0/0");
@@ -173,6 +175,7 @@ impl TestEnv {
 
         let auth_config = format!("-{}", rpc_auth);
         let mut bitcoin_config = config.bitcoind.clone();
+        bitcoin_config.p2p = corepc_node::P2P::Yes;
         bitcoin_config.args.push(&*auth_config);
 
         let bitcoind = match std::env::var("BITCOIND_EXEC") {
@@ -243,7 +246,7 @@ impl TestEnv {
         let bitcoind_rpc_port = self.bitcoind.params.rpc_socket.port();
         let browserport = get_available_port()?;
 
-        let electrum_port = self.electrsd.electrum_url.split(':').last()
+        let electrum_port = self.electrsd.electrum_url.split(':').next_back()
                 .context("Failed to parse electrum port")?;
 
         let container_name = format!("btc-explorer-{}", browserport);
@@ -439,6 +442,11 @@ impl TestEnv {
     pub fn workdir(&self) -> std::path::PathBuf {
         self.electrsd.workdir()
     }
+
+    /// Get the running bitcoind socket address
+    pub fn p2p_socket_addr(&self) -> Option<SocketAddrV4> {
+        self.bitcoind.params.p2p_socket
+    }
 }
 
 impl Drop for TestEnv {

testenv/src/lib.rs

@@ -16,7 +16,9 @@ hex = { workspace = true }
 base64 = { workspace = true }
 zeroize = { workspace = true }
 rustls = { workspace = true }
-
+bdk_kyoto = { workspace = true }
+tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
 [dev-dependencies]
 tempfile = "3.23.0"
 bdk_wallet = { workspace = true , features = ["test-utils"]}

wallet/Cargo.toml

@@ -6,6 +6,7 @@ It currently provides the following features:
 
 - Importing of secrets
 - Syncing with BDK Electrum
+- Syncing using Compact Block Filters (CBF)
 - Uses Sqlite to store additional information outside of the BDK structure
 
 # Running tests