Skip to content

Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
randomlogin wants to merge 2 commits into from
Closed

Add syncing via compact block filters (bip157) #821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ff3c7e
Add builders' stub for bip157 sync
randomlogin Mar 9, 2026
90eb045
Implement syncing via bip157 (kyoto)
randomlogin Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down
70 changes: 68 additions & 2 deletions src/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
rpc_password: String,
rest_client_config: Option<BitcoindRestClientConfig>,
},
CompactBlockFilter {
peers: Vec<std::net::SocketAddr>,
},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
config: Config,
chain_data_source_config: Option<ChainDataSourceConfig>,
fee_source_config: Option<FeeSourceConfig>,
gossip_source_config: Option<GossipSourceConfig>,
liquidity_source_config: Option<LiquiditySourceConfig>,
log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
/// Creates a new builder instance from an [`Config`].
pub fn from_config(config: Config) -> Self {
let chain_data_source_config = None;
let fee_source_config = None;
let gossip_source_config = None;
let liquidity_source_config = None;
let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
Self {
config,
chain_data_source_config,
fee_source_config,
gossip_source_config,
liquidity_source_config,
log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
self
}

/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
///
/// The given `peers` will be used as seed peers for the compact block filter node. An empty
/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
/// provided.
pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
self.chain_data_source_config =
Some(ChainDataSourceConfig::CompactBlockFilter { peers });
self
}

/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
///
/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
///
/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
self
}

/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
///
/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
///
/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
self
}

/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
///
/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
build_with_store_internal(
config,
self.chain_data_source_config.as_ref(),
self.fee_source_config.clone(),
self.gossip_source_config.as_ref(),
self.liquidity_source_config.as_ref(),
self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
);
}

/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
self.inner.write().unwrap().set_chain_source_bip157(peers);
}

/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
pub fn set_fee_source_esplora(&self, server_url: String) {
self.inner.write().unwrap().set_fee_source_esplora(server_url);
}

/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
pub fn set_fee_source_electrum(&self, server_url: String) {
self.inner.write().unwrap().set_fee_source_electrum(server_url);
}

/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
/// network.
pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
liquidity_source_config: Option<&LiquiditySourceConfig>,
pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
.await
}),
},
Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
peers.clone(),
fee_source_config,
Arc::clone(&fee_estimator),
Arc::clone(&tx_broadcaster),
Arc::clone(&kv_store),
Arc::clone(&config),
Arc::clone(&logger),
Arc::clone(&node_metrics),
),

None => {
// Default to Esplora client.
Expand Down
2 changes: 1 addition & 1 deletion src/chain/electrum.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
server_url: String,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add syncing via compact block filters (bip157) by randomlogin · Pull Request #821 · lightningdevkit/ldk-node · GitHub
Skip to content
Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

randomlogin
wants to merge
2
commits into

from

 Closed


Add syncing via compact block filters (bip157)
#821
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7ff3c7e

Add builders' stub for bip157 sync


randomlogin Mar 9, 2026
90eb045

Implement syncing via bip157 (kyoto)


randomlogin Mar 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down

70 changes: 68 additions & 2 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
	BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
	CompactBlockFilter {
 peers: Vec<std::net::SocketAddr>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
	config: Config,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	fee_source_config: Option<FeeSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
	/// Creates a new builder instance from an [`Config`].
	pub fn from_config(config: Config) -> Self {
 let chain_data_source_config = None;
 let fee_source_config = None;
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
 Self {
 config,
 chain_data_source_config,
 fee_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
	///
	/// The given `peers` will be used as seed peers for the compact block filter node. An empty
	/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
	/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
	/// provided.
	pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::CompactBlockFilter { peers });
 self
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
 self
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
 self
	}

	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
	///
	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
 build_with_store_internal(
 config,
 self.chain_data_source_config.as_ref(),
 self.fee_source_config.clone(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
 );
	}

	/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
	pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
 self.inner.write().unwrap().set_chain_source_bip157(peers);
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	pub fn set_fee_source_esplora(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_esplora(server_url);
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	pub fn set_fee_source_electrum(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_electrum(server_url);
	}

	/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
	/// network.
	pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>,
	pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
	async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
 .await
 }),
 },
 Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
 peers.clone(),
 fee_source_config,
 Arc::clone(&fee_estimator),
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ),

 None => {
 // Default to Esplora client.
Expand Down

2 changes: 1 addition & 1 deletion
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
	server_url: String,
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add syncing via compact block filters (bip157) by randomlogin · Pull Request #821 · lightningdevkit/ldk-node · GitHub
Skip to content
Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

randomlogin
wants to merge
2
commits into

from

 Closed


Add syncing via compact block filters (bip157)
#821
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7ff3c7e

Add builders' stub for bip157 sync


randomlogin Mar 9, 2026
90eb045

Implement syncing via bip157 (kyoto)


randomlogin Mar 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down

70 changes: 68 additions & 2 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
	BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
	CompactBlockFilter {
 peers: Vec<std::net::SocketAddr>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
	config: Config,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	fee_source_config: Option<FeeSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
	/// Creates a new builder instance from an [`Config`].
	pub fn from_config(config: Config) -> Self {
 let chain_data_source_config = None;
 let fee_source_config = None;
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
 Self {
 config,
 chain_data_source_config,
 fee_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
	///
	/// The given `peers` will be used as seed peers for the compact block filter node. An empty
	/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
	/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
	/// provided.
	pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::CompactBlockFilter { peers });
 self
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
 self
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
 self
	}

	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
	///
	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
 build_with_store_internal(
 config,
 self.chain_data_source_config.as_ref(),
 self.fee_source_config.clone(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
 );
	}

	/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
	pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
 self.inner.write().unwrap().set_chain_source_bip157(peers);
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	pub fn set_fee_source_esplora(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_esplora(server_url);
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	pub fn set_fee_source_electrum(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_electrum(server_url);
	}

	/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
	/// network.
	pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>,
	pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
	async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
 .await
 }),
 },
 Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
 peers.clone(),
 fee_source_config,
 Arc::clone(&fee_estimator),
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ),

 None => {
 // Default to Esplora client.
Expand Down

2 changes: 1 addition & 1 deletion
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
	server_url: String,
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add syncing via compact block filters (bip157) by randomlogin · Pull Request #821 · lightningdevkit/ldk-node · GitHub
Skip to content
Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

randomlogin
wants to merge
2
commits into

from

 Closed


Add syncing via compact block filters (bip157)
#821
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7ff3c7e

Add builders' stub for bip157 sync


randomlogin Mar 9, 2026
90eb045

Implement syncing via bip157 (kyoto)


randomlogin Mar 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down

70 changes: 68 additions & 2 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
	BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
	CompactBlockFilter {
 peers: Vec<std::net::SocketAddr>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
	config: Config,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	fee_source_config: Option<FeeSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
	/// Creates a new builder instance from an [`Config`].
	pub fn from_config(config: Config) -> Self {
 let chain_data_source_config = None;
 let fee_source_config = None;
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
 Self {
 config,
 chain_data_source_config,
 fee_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
	///
	/// The given `peers` will be used as seed peers for the compact block filter node. An empty
	/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
	/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
	/// provided.
	pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::CompactBlockFilter { peers });
 self
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
 self
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
 self
	}

	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
	///
	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
 build_with_store_internal(
 config,
 self.chain_data_source_config.as_ref(),
 self.fee_source_config.clone(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
 );
	}

	/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
	pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
 self.inner.write().unwrap().set_chain_source_bip157(peers);
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	pub fn set_fee_source_esplora(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_esplora(server_url);
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	pub fn set_fee_source_electrum(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_electrum(server_url);
	}

	/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
	/// network.
	pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>,
	pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
	async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
 .await
 }),
 },
 Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
 peers.clone(),
 fee_source_config,
 Arc::clone(&fee_estimator),
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ),

 None => {
 // Default to Esplora client.
Expand Down

2 changes: 1 addition & 1 deletion
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
	server_url: String,
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add syncing via compact block filters (bip157) by randomlogin · Pull Request #821 · lightningdevkit/ldk-node · GitHub
Skip to content
Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

randomlogin
wants to merge
2
commits into

from

 Closed


Add syncing via compact block filters (bip157)
#821
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7ff3c7e

Add builders' stub for bip157 sync


randomlogin Mar 9, 2026
90eb045

Implement syncing via bip157 (kyoto)


randomlogin Mar 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down

70 changes: 68 additions & 2 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
	BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
	CompactBlockFilter {
 peers: Vec<std::net::SocketAddr>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
	config: Config,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	fee_source_config: Option<FeeSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
	/// Creates a new builder instance from an [`Config`].
	pub fn from_config(config: Config) -> Self {
 let chain_data_source_config = None;
 let fee_source_config = None;
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
 Self {
 config,
 chain_data_source_config,
 fee_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
	///
	/// The given `peers` will be used as seed peers for the compact block filter node. An empty
	/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
	/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
	/// provided.
	pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::CompactBlockFilter { peers });
 self
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
 self
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
 self
	}

	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
	///
	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
 build_with_store_internal(
 config,
 self.chain_data_source_config.as_ref(),
 self.fee_source_config.clone(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
 );
	}

	/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
	pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
 self.inner.write().unwrap().set_chain_source_bip157(peers);
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	pub fn set_fee_source_esplora(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_esplora(server_url);
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	pub fn set_fee_source_electrum(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_electrum(server_url);
	}

	/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
	/// network.
	pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>,
	pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
	async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
 .await
 }),
 },
 Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
 peers.clone(),
 fee_source_config,
 Arc::clone(&fee_estimator),
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ),

 None => {
 // Default to Esplora client.
Expand Down

2 changes: 1 addition & 1 deletion
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
	server_url: String,
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add syncing via compact block filters (bip157) by randomlogin · Pull Request #821 · lightningdevkit/ldk-node · GitHub
Skip to content
Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

randomlogin
wants to merge
2
commits into

from

 Closed


Add syncing via compact block filters (bip157)
#821
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7ff3c7e

Add builders' stub for bip157 sync


randomlogin Mar 9, 2026
90eb045

Implement syncing via bip157 (kyoto)


randomlogin Mar 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down

70 changes: 68 additions & 2 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
	BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
	CompactBlockFilter {
 peers: Vec<std::net::SocketAddr>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
	config: Config,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	fee_source_config: Option<FeeSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
	/// Creates a new builder instance from an [`Config`].
	pub fn from_config(config: Config) -> Self {
 let chain_data_source_config = None;
 let fee_source_config = None;
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
 Self {
 config,
 chain_data_source_config,
 fee_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
	///
	/// The given `peers` will be used as seed peers for the compact block filter node. An empty
	/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
	/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
	/// provided.
	pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::CompactBlockFilter { peers });
 self
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
 self
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
 self
	}

	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
	///
	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
 build_with_store_internal(
 config,
 self.chain_data_source_config.as_ref(),
 self.fee_source_config.clone(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
 );
	}

	/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
	pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
 self.inner.write().unwrap().set_chain_source_bip157(peers);
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	pub fn set_fee_source_esplora(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_esplora(server_url);
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	pub fn set_fee_source_electrum(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_electrum(server_url);
	}

	/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
	/// network.
	pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>,
	pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
	async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
 .await
 }),
 },
 Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
 peers.clone(),
 fee_source_config,
 Arc::clone(&fee_estimator),
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ),

 None => {
 // Default to Esplora client.
Expand Down

2 changes: 1 addition & 1 deletion
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
	server_url: String,
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add syncing via compact block filters (bip157) by randomlogin · Pull Request #821 · lightningdevkit/ldk-node · GitHub
Skip to content
Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

randomlogin
wants to merge
2
commits into

from

 Closed


Add syncing via compact block filters (bip157)
#821
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7ff3c7e

Add builders' stub for bip157 sync


randomlogin Mar 9, 2026
90eb045

Implement syncing via bip157 (kyoto)


randomlogin Mar 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down

70 changes: 68 additions & 2 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
	BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
	CompactBlockFilter {
 peers: Vec<std::net::SocketAddr>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
	config: Config,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	fee_source_config: Option<FeeSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
	/// Creates a new builder instance from an [`Config`].
	pub fn from_config(config: Config) -> Self {
 let chain_data_source_config = None;
 let fee_source_config = None;
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
 Self {
 config,
 chain_data_source_config,
 fee_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
	///
	/// The given `peers` will be used as seed peers for the compact block filter node. An empty
	/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
	/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
	/// provided.
	pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::CompactBlockFilter { peers });
 self
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
 self
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
 self
	}

	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
	///
	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
 build_with_store_internal(
 config,
 self.chain_data_source_config.as_ref(),
 self.fee_source_config.clone(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
 );
	}

	/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
	pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
 self.inner.write().unwrap().set_chain_source_bip157(peers);
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	pub fn set_fee_source_esplora(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_esplora(server_url);
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	pub fn set_fee_source_electrum(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_electrum(server_url);
	}

	/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
	/// network.
	pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>,
	pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
	async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
 .await
 }),
 },
 Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
 peers.clone(),
 fee_source_config,
 Arc::clone(&fee_estimator),
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ),

 None => {
 // Default to Esplora client.
Expand Down

2 changes: 1 addition & 1 deletion
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
	server_url: String,
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add syncing via compact block filters (bip157) by randomlogin · Pull Request #821 · lightningdevkit/ldk-node · GitHub
Skip to content
Add syncing via compact block filters (bip157)#821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

randomlogin
wants to merge
2
commits into

from

 Closed


Add syncing via compact block filters (bip157)
#821
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
7ff3c7e

Add builders' stub for bip157 sync


randomlogin Mar 9, 2026
90eb045

Implement syncing via bip157 (kyoto)


randomlogin Mar 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,6 +76,7 @@ serde_json = { version = "1.0.128", default-features = false, features = ["std"]
log = { version = "0.4.22", default-features = false, features = ["std"]}

async-trait = { version = "0.1", default-features = false }
bip157 = "0.4.2"
vss-client = { package = "vss-client-ng", version = "0.5" }
prost = { version = "0.11.6", default-features = false}
#bitcoin-payment-instructions = { version = "0.6" }
Expand All@@ -91,7 +92,6 @@ proptest = "1.0.0"
regex = "1.5.6"
criterion = { version = "0.7.0", features = ["async_tokio"] }
ldk-node-062 = { package = "ldk-node", version = "=0.6.2" }

[target.'cfg(not(no_download))'.dev-dependencies]
electrsd = { version = "0.36.1", default-features = false, features = ["legacy", "esplora_a33e97e1", "corepc-node_27_2"] }

Expand Down

70 changes: 68 additions & 2 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,7 @@ use lightning::util::sweep::OutputSweeper;
use lightning_persister::fs_store::v1::FilesystemStore;
use vss_client::headers::VssHeaderProvider;

use crate::chain::ChainSource;
use crate::chain::{ChainSource, FeeSourceConfig};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, AsyncPaymentsRole,
	BitcoindRestClientConfig, Config, ElectrumSyncConfig, EsploraSyncConfig,
Expand DownExpand Up@@ -105,6 +105,9 @@ enum ChainDataSourceConfig {
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
	CompactBlockFilter {
 peers: Vec<std::net::SocketAddr>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -240,6 +243,7 @@ impl std::error::Error for BuildError {}
pub struct NodeBuilder {
	config: Config,
	chain_data_source_config: Option<ChainDataSourceConfig>,
	fee_source_config: Option<FeeSourceConfig>,
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
Expand All@@ -259,6 +263,7 @@ impl NodeBuilder {
	/// Creates a new builder instance from an [`Config`].
	pub fn from_config(config: Config) -> Self {
 let chain_data_source_config = None;
 let fee_source_config = None;
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
Expand All@@ -268,6 +273,7 @@ impl NodeBuilder {
 Self {
 config,
 chain_data_source_config,
 fee_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
Expand DownExpand Up@@ -352,6 +358,40 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data via BIP157 compact block filters.
	///
	/// The given `peers` will be used as seed peers for the compact block filter node. An empty
	/// list is valid for standard networks (mainnet, testnet, signet) where DNS seeds are used
	/// for peer discovery. For custom networks (e.g. custom signets), at least one peer must be
	/// provided.
	pub fn set_chain_source_bip157(&mut self, peers: Vec<std::net::SocketAddr>) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::CompactBlockFilter { peers });
 self
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_esplora(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Esplora(server_url));
 self
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	///
	/// By default the BIP-157 backend derives fee rates from the latest block's coinbase output.
	/// Setting this provides more accurate, per-target fee estimates from a mempool-aware server.
	///
	/// Only takes effect when the chain source is set to BIP-157 via [`Self::set_chain_source_bip157`].
	pub fn set_fee_source_electrum(&mut self, server_url: String) -> &mut Self {
 self.fee_source_config = Some(FeeSourceConfig::Electrum(server_url));
 self
	}

	/// Configures the [`Node`] instance to synchronize chain data from a Bitcoin Core REST endpoint.
	///
	/// This method enables chain data synchronization via Bitcoin Core's REST interface. We pass
Expand DownExpand Up@@ -727,6 +767,7 @@ impl NodeBuilder {
 build_with_store_internal(
 config,
 self.chain_data_source_config.as_ref(),
 self.fee_source_config.clone(),
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 self.pathfinding_scores_sync_config.as_ref(),
Expand DownExpand Up@@ -847,6 +888,21 @@ impl ArcedNodeBuilder {
 );
	}

	/// Configures the [`Node`] instance to synchronize chain data via BIP-157 compact block filters.
	pub fn set_chain_source_bip157(&self, peers: Vec<std::net::SocketAddr>) {
 self.inner.write().unwrap().set_chain_source_bip157(peers);
	}

	/// Configures the BIP-157 chain source to use an Esplora server for fee rate estimation.
	pub fn set_fee_source_esplora(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_esplora(server_url);
	}

	/// Configures the BIP-157 chain source to use an Electrum server for fee rate estimation.
	pub fn set_fee_source_electrum(&self, server_url: String) {
 self.inner.write().unwrap().set_fee_source_electrum(server_url);
	}

	/// Configures the [`Node`] instance to source its gossip data from the Lightning peer-to-peer
	/// network.
	pub fn set_gossip_source_p2p(&self) {
Expand DownExpand Up@@ -1121,7 +1177,7 @@ impl ArcedNodeBuilder {
/// Builds a [`Node`] instance according to the options previously configured.
fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
fee_source_config: Option<FeeSourceConfig>, gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>,
	pathfinding_scores_sync_config: Option<&PathfindingScoresSyncConfig>,
	async_payments_role: Option<AsyncPaymentsRole>, recovery_mode: bool, seed_bytes: [u8; 64],
Expand DownExpand Up@@ -1254,6 +1310,16 @@ fn build_with_store_internal(
 .await
 }),
 },
 Some(ChainDataSourceConfig::CompactBlockFilter { peers }) => ChainSource::new_kyoto(
 peers.clone(),
 fee_source_config,
 Arc::clone(&fee_estimator),
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ),

 None => {
 // Default to Esplora client.
Expand Down

2 changes: 1 addition & 1 deletion
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,7 +37,7 @@ use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

const BDK_ELECTRUM_CLIENT_BATCH_SIZE: usize = 5;
const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;
pub(crate) const ELECTRUM_CLIENT_NUM_RETRIES: u8 = 3;

pub(super) struct ElectrumChainSource {
	server_url: String,
Expand Down
Loading
Loading