Add compact block filters blockchain feature using the Nakamoto client

bdk-ffi/src/bdk.udl

@@ -46,6 +46,7 @@ enum BdkError {
   "Sled",
   "Rusqlite",
   "Rpc",
+  "CompactFilters",
 };
 
 dictionary AddressInfo {
@@ -155,11 +156,23 @@ dictionary RpcConfig {
     RpcSyncParams? sync_params;
 };
 
+
+
+
+dictionary CompactFiltersConfig {
+  sequence<string> addresses;
+  Network network;
+  string storage_dir;
+  u32 skip_blocks;
+};
+
+
 [Enum]
 interface BlockchainConfig {
   Electrum(ElectrumConfig config);
   Esplora(EsploraConfig config);
   Rpc(RpcConfig config);
+  Cbf(CompactFiltersConfig config);
 };
 
 interface Blockchain {
@@ -221,8 +234,6 @@ interface Wallet {
   [Throws=BdkError]
   constructor(Descriptor descriptor, Descriptor? change_descriptor, Network network, DatabaseConfig database_config);
 
-  Network network();
-
   [Throws=BdkError]
   AddressInfo get_address(AddressIndex address_index);
 

bdk-ffi/src/blockchain.rs

@@ -2,6 +2,7 @@
 use crate::{BdkError, Transaction};
 use bdk::bitcoin::Network;
 use bdk::blockchain::any::{AnyBlockchain, AnyBlockchainConfig};
+use bdk::blockchain::compact_filters::nakamoto::CBFBlockchainConfig;
 use bdk::blockchain::rpc::Auth as BdkAuth;
 use bdk::blockchain::rpc::RpcSyncParams as BdkRpcSyncParams;
 use bdk::blockchain::Blockchain as BdkBlockchain;
@@ -10,6 +11,7 @@ use bdk::blockchain::GetHeight;
 use bdk::blockchain::{
     electrum::ElectrumBlockchainConfig, esplora::EsploraBlockchainConfig,
     rpc::RpcConfig as BdkRpcConfig, ConfigurableBlockchain,
+    compact_filters::CompactFiltersBlockchainConfig, compact_filters::BitcoinPeerConfig,
 };
 use bdk::FeeRate;
 use std::convert::{From, TryFrom};
@@ -42,13 +44,58 @@ impl Blockchain {
                     timeout: config.timeout,
                 })
             }
+            BlockchainConfig::Cbf { config } => {
+
+                let mut peers = Vec::new();
+                let peer = BitcoinPeerConfig{
+                    address:config.address,
+                    socks5:None,
+                    socks5_credentials:None
+                };
+                peers.push(peer);
+
+
+
+                AnyBlockchainConfig::CompactFilters(CompactFiltersBlockchainConfig {
+                    peers: peers,
+                    network: config.network,
+                    storage_dir: config.storage_dir,
+                    skip_blocks : match usize::try_from(config.skip_blocks) {
+                        Ok(value) => Some(value),
+                        Err(_) => None,
+                    }
+                      ,
+                })
+            }
             BlockchainConfig::Rpc { config } => AnyBlockchainConfig::Rpc(BdkRpcConfig {
                 url: config.url,
                 auth: config.auth.into(),
                 network: config.network,
                 wallet_name: config.wallet_name,
                 sync_params: config.sync_params.map(|p| p.into()),
             }),
+            // TODO: not sure this is the right way to deal with the PathBuf
+            // Attempt 1, if you make datadir an Option<String> in the CBFConfig struct
+            // BlockchainConfig::CBF { config } => {
+            //     let path0: String = config
+            //         .datadir
+            //         .map(|d| d)
+            //         .unwrap_or(String::from("./nakamoto/"));
+            //     let path: PathBuf = PathBuf::from(path0);
+            //     AnyBlockchainConfig::CompactFilters(CBFBlockchainConfig {
+            //         network: config.network,
+            //         datadir: Some(path),
+            //     })
+            // }
+
+            // Attempt 2, if you make the datadir field mandatory
+            BlockchainConfig::CBF { config } => {
+                AnyBlockchainConfig::CompactFilters(CBFBlockchainConfig {
+                    network: config.network,
+                    datadir: Some(PathBuf::from(config.datadir)),
+                })
+            }
+            })
         };
         let blockchain = AnyBlockchain::from_config(&any_blockchain_config)?;
         Ok(Self {
@@ -190,6 +237,14 @@ pub struct RpcConfig {
     pub sync_params: Option<RpcSyncParams>,
 }
 
+
+pub struct CompactFiltersConfig {
+    pub addresses: Vec<String>,
+    pub network: Network,
+    pub storage_dir: String,
+    pub skip_blocks: u32,
+}
+
 /// Type that can contain any of the blockchain configurations defined by the library.
 pub enum BlockchainConfig {
     /// Electrum client
@@ -198,4 +253,6 @@ pub enum BlockchainConfig {
     Esplora { config: EsploraConfig },
     /// Bitcoin Core RPC client
     Rpc { config: RpcConfig },
+    /// CompactFilters
+    Cbf { config: CompactFiltersConfig },
 }

bdk-ffi/src/lib.rs

@@ -6,7 +6,7 @@ mod psbt;
 mod wallet;
 
 use crate::blockchain::{
-    Auth, Blockchain, BlockchainConfig, ElectrumConfig, EsploraConfig, RpcConfig, RpcSyncParams,
+    Auth, Blockchain, BlockchainConfig, ElectrumConfig, EsploraConfig, RpcConfig, CompactFiltersConfig, RpcSyncParams,
 };
 use crate::database::DatabaseConfig;
 use crate::descriptor::Descriptor;