nakamoto as Compact Block Filter Blockchain

Cargo.toml

@@ -19,6 +19,7 @@ bitcoin = { version = "0.29.1", features = ["serde", "base64", "rand"] }
 serde = { version = "^1.0", features = ["derive"] }
 serde_json = { version = "^1.0" }
 rand = "^0.8"
+thiserror = "1.0"
 
 # Optional dependencies
 sled = { version = "0.34", optional = true }
@@ -39,6 +40,9 @@ bitcoinconsensus = { version = "0.19.0-3", optional = true }
 # Needed by bdk_blockchain_tests macro and the `rpc` feature
 bitcoincore-rpc = { version = "0.16", optional = true }
 
+# Nakamoto crates for the CBF blockchain
+# nakamoto = { git = "https://github.com/cloudhead/nakamoto.git", rev = "14902d3d5cc9442cdda82419f0f24277d86b243b", optional = true }
+nakamoto = { version = "0.4.0", optional = true }
 # Platform-specific dependencies
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 tokio = { version = "1", features = ["rt", "macros"] }
@@ -55,7 +59,7 @@ verify = ["bitcoinconsensus"]
 default = ["key-value-db", "electrum"]
 sqlite = ["rusqlite", "ahash"]
 sqlite-bundled = ["sqlite", "rusqlite/bundled"]
-compact_filters = ["rocksdb", "socks", "cc"]
+compact_filters = ["nakamoto"]
 key-value-db = ["sled"]
 all-keys = ["keys-bip39"]
 keys-bip39 = ["bip39"]
@@ -93,6 +97,7 @@ reqwest-default-tls = ["esplora-client/async-https"]
 test-blockchains = ["bitcoincore-rpc", "electrum-client"]
 test-electrum = ["electrum", "electrsd/electrs_0_8_10", "electrsd/bitcoind_22_0", "test-blockchains"]
 test-rpc = ["rpc", "electrsd/electrs_0_8_10", "electrsd/bitcoind_22_0", "test-blockchains"]
+test-cbf = ["compact_filters", "electrsd/electrs_0_8_10", "electrsd/bitcoind_22_0", "test-blockchains"]
 test-rpc-legacy = ["rpc", "electrsd/electrs_0_8_10", "electrsd/bitcoind_0_20_0", "test-blockchains"]
 test-esplora = ["electrsd/legacy", "electrsd/esplora_a33e97e1", "electrsd/bitcoind_22_0", "test-blockchains"]
 test-md-docs = ["electrum"]

examples/compact_filters_balance.rs

@@ -1,41 +1,44 @@
-// Bitcoin Dev Kit
-// Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
-//
-// Copyright (c) 2020-2021 Bitcoin Dev Kit Developers
-//
-// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
-// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
-// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
-// You may not use this file except in accordance with one or both of these
-// licenses.
+// // Bitcoin Dev Kit
+// // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
+// //
+// // Copyright (c) 2020-2021 Bitcoin Dev Kit Developers
+// //
+// // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+// // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+// // You may not use this file except in accordance with one or both of these
+// // licenses.
 
-use bdk::blockchain::compact_filters::*;
-use bdk::database::MemoryDatabase;
-use bdk::*;
-use bitcoin::*;
-use blockchain::compact_filters::CompactFiltersBlockchain;
-use blockchain::compact_filters::CompactFiltersError;
-use log::info;
-use std::sync::Arc;
+// use bdk::blockchain::compact_filters::*;
+// use bdk::database::MemoryDatabase;
+// use bdk::*;
+// use bitcoin::*;
+// use blockchain::compact_filters::CompactFiltersBlockchain;
+// use blockchain::compact_filters::CompactFiltersError;
+// use log::info;
+// use std::sync::Arc;
 
-/// This will return wallet balance using compact filters
-/// Requires a synced local bitcoin node 0.21 running on testnet with blockfilterindex=1 and peerblockfilters=1
-fn main() -> Result<(), CompactFiltersError> {
-    env_logger::init();
-    info!("start");
+// /// This will return wallet balance using compact filters
+// /// Requires a synced local bitcoin node 0.21 running on testnet with blockfilterindex=1 and peerblockfilters=1
+// fn main() -> Result<(), CompactFiltersError> {
+//     env_logger::init();
+//     info!("start");
 
-    let num_threads = 4;
-    let mempool = Arc::new(Mempool::default());
-    let peers = (0..num_threads)
-        .map(|_| Peer::connect("localhost:18333", Arc::clone(&mempool), Network::Testnet))
-        .collect::<Result<_, _>>()?;
-    let blockchain = CompactFiltersBlockchain::new(peers, "./wallet-filters", Some(500_000))?;
-    info!("done {:?}", blockchain);
-    let descriptor = "wpkh(tpubD6NzVbkrYhZ4X2yy78HWrr1M9NT8dKeWfzNiQqDdMqqa9UmmGztGGz6TaLFGsLfdft5iu32gxq1T4eMNxExNNWzVCpf9Y6JZi5TnqoC9wJq/*)";
+//     let num_threads = 4;
+//     let mempool = Arc::new(Mempool::default());
+//     let peers = (0..num_threads)
+//         .map(|_| Peer::connect("localhost:18333", Arc::clone(&mempool), Network::Testnet))
+//         .collect::<Result<_, _>>()?;
+//     let blockchain = CompactFiltersBlockchain::new(peers, "./wallet-filters", Some(500_000))?;
+//     info!("done {:?}", blockchain);
+//     let descriptor = "wpkh(tpubD6NzVbkrYhZ4X2yy78HWrr1M9NT8dKeWfzNiQqDdMqqa9UmmGztGGz6TaLFGsLfdft5iu32gxq1T4eMNxExNNWzVCpf9Y6JZi5TnqoC9wJq/*)";
 
-    let database = MemoryDatabase::default();
-    let wallet = Arc::new(Wallet::new(descriptor, None, Network::Testnet, database).unwrap());
-    wallet.sync(&blockchain, SyncOptions::default()).unwrap();
-    info!("balance: {}", wallet.get_balance()?);
-    Ok(())
-}
+//     let database = MemoryDatabase::default();
+//     let wallet = Arc::new(Wallet::new(descriptor, None, Network::Testnet, database).unwrap());
+//     wallet.sync(&blockchain, SyncOptions::default()).unwrap();
+//     info!("balance: {}", wallet.get_balance()?);
+//     Ok(())
+// }
+
+// TODO make a nakamoto example
+fn main() {}

src/blockchain/any.rs

@@ -84,7 +84,7 @@ pub enum AnyBlockchain {
     #[cfg(feature = "compact_filters")]
     #[cfg_attr(docsrs, doc(cfg(feature = "compact_filters")))]
     /// Compact filters client
-    CompactFilters(Box<compact_filters::CompactFiltersBlockchain>),
+    CompactFilters(Box<compact_filters::nakamoto::CbfBlockchain>),
     #[cfg(feature = "rpc")]
     #[cfg_attr(docsrs, doc(cfg(feature = "rpc")))]
     /// RPC client
@@ -158,7 +158,7 @@ impl WalletSync for AnyBlockchain {
 
 impl_from!(boxed electrum::ElectrumBlockchain, AnyBlockchain, Electrum, #[cfg(feature = "electrum")]);
 impl_from!(boxed esplora::EsploraBlockchain, AnyBlockchain, Esplora, #[cfg(feature = "esplora")]);
-impl_from!(boxed compact_filters::CompactFiltersBlockchain, AnyBlockchain, CompactFilters, #[cfg(feature = "compact_filters")]);
+impl_from!(boxed compact_filters::nakamoto::CbfBlockchain, AnyBlockchain, CompactFilters, #[cfg(feature = "compact_filters")]);
 impl_from!(boxed rpc::RpcBlockchain, AnyBlockchain, Rpc, #[cfg(feature = "rpc")]);
 
 /// Type that can contain any of the blockchain configurations defined by the library
@@ -210,7 +210,7 @@ pub enum AnyBlockchainConfig {
     #[cfg(feature = "compact_filters")]
     #[cfg_attr(docsrs, doc(cfg(feature = "compact_filters")))]
     /// Compact filters client
-    CompactFilters(compact_filters::CompactFiltersBlockchainConfig),
+    CompactFilters(compact_filters::nakamoto::CBFBlockchainConfig),
     #[cfg(feature = "rpc")]
     #[cfg_attr(docsrs, doc(cfg(feature = "rpc")))]
     /// RPC client configuration
@@ -232,7 +232,7 @@ impl ConfigurableBlockchain for AnyBlockchain {
             }
             #[cfg(feature = "compact_filters")]
             AnyBlockchainConfig::CompactFilters(inner) => AnyBlockchain::CompactFilters(Box::new(
-                compact_filters::CompactFiltersBlockchain::from_config(inner)?,
+                compact_filters::nakamoto::CbfBlockchain::from_config(inner)?,
             )),
             #[cfg(feature = "rpc")]
             AnyBlockchainConfig::Rpc(inner) => {
@@ -244,5 +244,5 @@ impl ConfigurableBlockchain for AnyBlockchain {
 
 impl_from!(electrum::ElectrumBlockchainConfig, AnyBlockchainConfig, Electrum, #[cfg(feature = "electrum")]);
 impl_from!(esplora::EsploraBlockchainConfig, AnyBlockchainConfig, Esplora, #[cfg(feature = "esplora")]);
-impl_from!(compact_filters::CompactFiltersBlockchainConfig, AnyBlockchainConfig, CompactFilters, #[cfg(feature = "compact_filters")]);
+impl_from!(compact_filters::nakamoto::CBFBlockchainConfig, AnyBlockchainConfig, CompactFilters, #[cfg(feature = "compact_filters")]);
 impl_from!(rpc::RpcConfig, AnyBlockchainConfig, Rpc, #[cfg(feature = "rpc")]);