Add chain syncing via compact block filters (BIP 157)

Cargo.toml

@@ -32,6 +32,7 @@ default = [
 	"chain-esplora",
 	"chain-electrum",
 	"chain-bitcoind",
+	"chain-cbf",
 	"storage-sqlite",
 	"storage-filesystem",
 	"storage-vss",
@@ -52,6 +53,7 @@ chain-electrum = [
 	"lightning-transaction-sync/electrum-rustls-ring",
 ]
 chain-bitcoind = ["dep:lightning-block-sync"]
+chain-cbf = ["dep:bip157", "dep:lightning-block-sync"]
 storage-sqlite = ["dep:rusqlite"]
 storage-filesystem = ["dep:lightning-persister"]
 storage-vss = ["dep:vss-client", "dep:prost"]
@@ -103,6 +105,7 @@ bdk_chain = { version = "0.23.3", default-features = false, features = ["std"] }
 bdk_esplora = { version = "0.22.2", default-features = false, features = ["async-https-rustls", "tokio"], optional = true }
 bdk_electrum = { version = "0.24.0", default-features = false, features = ["use-rustls-ring"], optional = true }
 bdk_wallet = { version = "3.2.0", default-features = false, features = ["std", "keys-bip39"]}
+bip157 = { version = "0.9.0", default-features = false, optional = true }
 
 bitreq = { version = "0.3", default-features = false, features = ["async-https", "json-using-serde"] }
 rustls = { version = "0.23", default-features = false }

src/builder.rs

@@ -55,6 +55,8 @@ use lightning_dns_resolver::OMDomainResolver;
 use vss_client::headers::VssHeaderProvider;
 
 use crate::chain::ChainSource;
+#[cfg(feature = "chain-cbf")]
+use crate::chain::{CbfFeeSourceConfig, CbfNetworkConfig};
 #[cfg(feature = "chain-bitcoind")]
 use crate::config::BitcoindRestClientConfig;
 use crate::config::{
@@ -139,6 +141,11 @@ enum ChainDataSourceConfig {
 		rest_client_config: Option<BitcoindRestClientConfig>,
 		wallet_rescan_from_height: Option<u32>,
 	},
+	#[cfg(feature = "chain-cbf")]
+	Cbf {
+		network_config: Option<CbfNetworkConfig>,
+		fee_source_config: Option<CbfFeeSourceConfig>,
+	},
 }
 
 #[derive(Debug, Clone)]
@@ -440,6 +447,24 @@ impl NodeBuilder {
 		self
 	}
 
+	/// Configures the [`Node`] instance to source chain data via compact block filters
+	/// (BIP157/BIP158).
+	///
+	/// If no `network_config` is given, peers are discovered automatically. See
+	/// [`CbfNetworkConfig`] for more information on the peer settings.
+	///
+	/// `fee_source_config` optionally delegates fee estimation to an Esplora or Electrum server;
+	/// if `None`, fee rates are derived from recent blocks.
+	#[cfg(feature = "chain-cbf")]
+	pub fn set_chain_source_cbf(
+		&mut self, network_config: Option<CbfNetworkConfig>,
+		fee_source_config: Option<CbfFeeSourceConfig>,
+	) -> &mut Self {
+		self.chain_data_source_config =
+			Some(ChainDataSourceConfig::Cbf { network_config, fee_source_config });
+		self
+	}
+
 	/// Configures the [`Node`] instance to connect to a Bitcoin Core node via RPC.
 	///
 	/// This method establishes an RPC connection that enables all essential chain operations including
@@ -1101,6 +1126,28 @@ impl Builder {
 	}
 }
 
+#[cfg(all(feature = "uniffi", feature = "chain-cbf"))]
+#[uniffi::export]
+impl Builder {
+	/// Configures the [`Node`] instance to source chain data via compact block filters
+	/// (BIP157/BIP158).
+	///
+	/// If no `network_config` is given, peers are discovered automatically. See
+	/// [`CbfNetworkConfig`] for more information on the peer settings.
+	///
+	/// `fee_source_config` optionally delegates fee estimation to an Esplora or Electrum server;
+	/// if `None`, fee rates are derived from recent blocks.
+	pub fn set_chain_source_cbf(
+		&self, network_config: Option<CbfNetworkConfig>,
+		fee_source_config: Option<CbfFeeSourceConfig>,
+	) {
+		self.inner
+			.write()
+			.expect("lock")
+			.set_chain_source_cbf(network_config, fee_source_config);
+	}
+}
+
 #[cfg(all(feature = "uniffi", feature = "chain-bitcoind"))]
 #[uniffi::export]
 impl Builder {
@@ -1643,7 +1690,8 @@ fn build_with_store_internal(
 		},
 	};
 
-	let (chain_source, chain_tip_opt) = match chain_data_source_config {
+	#[allow(unused_mut)]
+	let (chain_source, mut chain_tip_opt) = match chain_data_source_config {
 		#[cfg(feature = "chain-esplora")]
 		Some(ChainDataSourceConfig::Esplora { server_url, headers, sync_config }) => {
 			let sync_config = sync_config.unwrap_or(EsploraSyncConfig::default());
@@ -1674,6 +1722,19 @@ fn build_with_store_internal(
 				Arc::clone(&node_metrics),
 			)
 		},
+		#[cfg(feature = "chain-cbf")]
+		Some(ChainDataSourceConfig::Cbf { network_config, fee_source_config }) => ChainSource::new_cbf(
+			network_config.clone(),
+			fee_source_config.clone(),
+			Arc::clone(&runtime),
+			Arc::clone(&fee_estimator),
+			Arc::clone(&tx_broadcaster),
+			Arc::clone(&kv_store),
+			Arc::clone(&config),
+			Arc::clone(&logger),
+			Arc::clone(&node_metrics),
+		)
+		.map_err(|_| BuildError::ChainSourceSetupFailed)?,
 		#[cfg(feature = "chain-bitcoind")]
 		Some(ChainDataSourceConfig::Bitcoind {
 			rpc_host,
@@ -1818,6 +1879,18 @@ fn build_with_store_internal(
 			wallet
 		},
 		None => {
+			// A CBF node has no trusted node to ask for the tip, so a fresh wallet discovers it
+			// with a short headers-only sync and starts there, as everything below it is empty.
+			#[cfg(feature = "chain-cbf")]
+			if chain_tip_opt.is_none()
+				&& matches!(chain_data_source_config, Some(ChainDataSourceConfig::Cbf { .. }))
+			{
+				let stable_tip = runtime
+					.block_on(chain_source.fetch_stable_tip())
+					.map_err(|_| BuildError::ChainTipFetchFailed)?;
+				chain_tip_opt = Some(stable_tip);
+			}
+
 			// Guard against silently setting the wallet birthday to genesis on a fresh node:
 			// if we are creating a new wallet but failed to learn the current chain tip from
 			// a Bitcoin Core RPC/REST backend, we'd otherwise persist fresh wallet state