Skip to content

feat: chain source rest sync#526

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

Merged
tnull merged 3 commits into from
Jul 1, 2025
Merged

feat: chain source rest sync #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1f27ef
prefactor: rename bitcoind_rpc to bitcoind
enigbe Jun 19, 2025
b7de5f8
prefactor: prepare client for REST interface support
enigbe Jun 30, 2025
36e4c7f
feat: support chain sourcing via REST interface
enigbe Jul 1, 2025
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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down
1 change: 1 addition & 0 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
void set_gossip_source_p2p();
void set_gossip_source_rgs(string rgs_server_url);
void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down
5 changes: 3 additions & 2 deletions docker-compose.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
"-rpcbind=0.0.0.0",
"-rpcuser=user",
"-rpcpassword=pass",
"-fallbackfee=0.00001"
"-fallbackfee=0.00001",
"-rest"
]
ports:
- "18443:18443" # Regtest RPC port
- "18443:18443" # Regtest REST and RPC port
- "18444:18444" # Regtest P2P port
networks:
- bitcoin-electrs
Expand Down
126 changes: 112 additions & 14 deletions src/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
Esplora {
server_url: String,
sync_config: Option<EsploraSyncConfig>,
},
Electrum {
server_url: String,
sync_config: Option<ElectrumSyncConfig>,
},
Bitcoind {
rpc_host: String,
rpc_port: u16,
rpc_user: String,
rpc_password: String,
rest_client_config: Option<BitcoindRestClientConfig>,
},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
self
}

/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
/// endpoint.
/// 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
/// transaction broadcasting and chain data synchronization.
///
/// ## Parameters:
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection.
pub fn set_chain_source_bitcoind_rpc(
&mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
) -> &mut Self {
self.chain_data_source_config =
Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
rpc_host,
rpc_port,
rpc_user,
rpc_password,
rest_client_config: None,
});
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
/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
///
/// ## Parameters:
/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection
pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.
&mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
rpc_user: String, rpc_password: String,
) -> &mut Self {
self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
rpc_host,
rpc_port,
rpc_user,
rpc_password,
rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
});

self
}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
}

/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
/// endpoint.
/// 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
Comment thread
enigbe marked this conversation as resolved.
/// transaction broadcasting and chain data synchronization.
///
/// ## Parameters:
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection.
pub fn set_chain_source_bitcoind_rpc(
&self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
);
}

/// 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
/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
///
/// ## Parameters:
/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
/// connection
pub fn set_chain_source_bitcoind_rest(
&self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
rpc_user: String, rpc_password: String,
) {
self.inner.write().unwrap().set_chain_source_bitcoind_rest(
rest_host,
rest_port,
rpc_host,
rpc_port,
rpc_user,
rpc_password,
);
}

/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
Arc::clone(&node_metrics),
))
},
Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
Arc::new(ChainSource::new_bitcoind_rpc(
Some(ChainDataSourceConfig::Bitcoind {
rpc_host,
rpc_port,
rpc_user,
rpc_password,
rest_client_config,
}) => match rest_client_config {
Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
rpc_host.clone(),
*rpc_port,
rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
Arc::clone(&tx_broadcaster),
Arc::clone(&kv_store),
Arc::clone(&config),
rest_client_config.clone(),
Arc::clone(&logger),
Arc::clone(&node_metrics),
))
)),
None => Arc::new(ChainSource::new_bitcoind_rpc(
rpc_host.clone(),
*rpc_port,
rpc_user.clone(),
rpc_password.clone(),
Arc::clone(&wallet),
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.
let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
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" + '
feat: chain source rest sync by enigbe · Pull Request #526 · lightningdevkit/ldk-node · GitHub
Skip to content
feat: chain source rest sync#526

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

 Merged

tnull
merged 3 commits into

from

Jul 1, 2025
 Merged


feat: chain source rest sync
#526
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c1f27ef

prefactor: rename bitcoind_rpc to bitcoind


enigbe Jun 19, 2025
b7de5f8

prefactor: prepare client for REST interface support


enigbe Jun 30, 2025
36e4c7f

feat: support chain sourcing via REST interface


enigbe Jul 1, 2025

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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down

1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down

5 changes: 3 additions & 2 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
 "-rpcbind=0.0.0.0",
 "-rpcuser=user",
 "-rpcpassword=pass",
 "-fallbackfee=0.00001"
 "-fallbackfee=0.00001",
 "-rest"
 ]
 ports:
 - "18443:18443" # Regtest RPC port
 - "18443:18443" # Regtest REST and RPC port
 - "18444:18444" # Regtest P2P port
 networks:
 - bitcoin-electrs
Expand Down

126 changes: 112 additions & 14 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
	EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
	default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
	ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
	WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
	Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
	Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
	BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
	Esplora {
 server_url: String,
 sync_config: Option<EsploraSyncConfig>,
	},
	Electrum {
 server_url: String,
 sync_config: Option<ElectrumSyncConfig>,
	},
	Bitcoind {
 rpc_host: String,
 rpc_port: u16,
 rpc_user: String,
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: None,
 });
 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.

 &mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
 });

 self
	}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
Comment thread
enigbe marked this conversation as resolved.

	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
 );
	}

	/// 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
 &self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) {
 self.inner.write().unwrap().set_chain_source_bitcoind_rest(
 rest_host,
 rest_port,
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 );
	}

	/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
 Arc::clone(&node_metrics),
 ))
 },
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
 Arc::new(ChainSource::new_bitcoind_rpc(
 Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config,
 }) => match rest_client_config {
 Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 rest_client_config.clone(),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ))
 )),
 None => Arc::new(ChainSource::new_bitcoind_rpc(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
 rpc_password.clone(),
 Arc::clone(&wallet),
 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.
 let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
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('^' + ".*" + '
feat: chain source rest sync by enigbe · Pull Request #526 · lightningdevkit/ldk-node · GitHub
Skip to content
feat: chain source rest sync#526

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

 Merged

tnull
merged 3 commits into

from

Jul 1, 2025
 Merged


feat: chain source rest sync
#526
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c1f27ef

prefactor: rename bitcoind_rpc to bitcoind


enigbe Jun 19, 2025
b7de5f8

prefactor: prepare client for REST interface support


enigbe Jun 30, 2025
36e4c7f

feat: support chain sourcing via REST interface


enigbe Jul 1, 2025

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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down

1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down

5 changes: 3 additions & 2 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
 "-rpcbind=0.0.0.0",
 "-rpcuser=user",
 "-rpcpassword=pass",
 "-fallbackfee=0.00001"
 "-fallbackfee=0.00001",
 "-rest"
 ]
 ports:
 - "18443:18443" # Regtest RPC port
 - "18443:18443" # Regtest REST and RPC port
 - "18444:18444" # Regtest P2P port
 networks:
 - bitcoin-electrs
Expand Down

126 changes: 112 additions & 14 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
	EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
	default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
	ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
	WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
	Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
	Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
	BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
	Esplora {
 server_url: String,
 sync_config: Option<EsploraSyncConfig>,
	},
	Electrum {
 server_url: String,
 sync_config: Option<ElectrumSyncConfig>,
	},
	Bitcoind {
 rpc_host: String,
 rpc_port: u16,
 rpc_user: String,
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: None,
 });
 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.

 &mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
 });

 self
	}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
Comment thread
enigbe marked this conversation as resolved.

	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
 );
	}

	/// 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
 &self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) {
 self.inner.write().unwrap().set_chain_source_bitcoind_rest(
 rest_host,
 rest_port,
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 );
	}

	/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
 Arc::clone(&node_metrics),
 ))
 },
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
 Arc::new(ChainSource::new_bitcoind_rpc(
 Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config,
 }) => match rest_client_config {
 Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 rest_client_config.clone(),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ))
 )),
 None => Arc::new(ChainSource::new_bitcoind_rpc(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
 rpc_password.clone(),
 Arc::clone(&wallet),
 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.
 let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
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('^' + ".*" + '
feat: chain source rest sync by enigbe · Pull Request #526 · lightningdevkit/ldk-node · GitHub
Skip to content
feat: chain source rest sync#526

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

 Merged

tnull
merged 3 commits into

from

Jul 1, 2025
 Merged


feat: chain source rest sync
#526
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c1f27ef

prefactor: rename bitcoind_rpc to bitcoind


enigbe Jun 19, 2025
b7de5f8

prefactor: prepare client for REST interface support


enigbe Jun 30, 2025
36e4c7f

feat: support chain sourcing via REST interface


enigbe Jul 1, 2025

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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down

1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down

5 changes: 3 additions & 2 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
 "-rpcbind=0.0.0.0",
 "-rpcuser=user",
 "-rpcpassword=pass",
 "-fallbackfee=0.00001"
 "-fallbackfee=0.00001",
 "-rest"
 ]
 ports:
 - "18443:18443" # Regtest RPC port
 - "18443:18443" # Regtest REST and RPC port
 - "18444:18444" # Regtest P2P port
 networks:
 - bitcoin-electrs
Expand Down

126 changes: 112 additions & 14 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
	EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
	default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
	ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
	WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
	Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
	Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
	BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
	Esplora {
 server_url: String,
 sync_config: Option<EsploraSyncConfig>,
	},
	Electrum {
 server_url: String,
 sync_config: Option<ElectrumSyncConfig>,
	},
	Bitcoind {
 rpc_host: String,
 rpc_port: u16,
 rpc_user: String,
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: None,
 });
 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.

 &mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
 });

 self
	}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
Comment thread
enigbe marked this conversation as resolved.

	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
 );
	}

	/// 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
 &self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) {
 self.inner.write().unwrap().set_chain_source_bitcoind_rest(
 rest_host,
 rest_port,
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 );
	}

	/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
 Arc::clone(&node_metrics),
 ))
 },
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
 Arc::new(ChainSource::new_bitcoind_rpc(
 Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config,
 }) => match rest_client_config {
 Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 rest_client_config.clone(),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ))
 )),
 None => Arc::new(ChainSource::new_bitcoind_rpc(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
 rpc_password.clone(),
 Arc::clone(&wallet),
 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.
 let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
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" + '
feat: chain source rest sync by enigbe · Pull Request #526 · lightningdevkit/ldk-node · GitHub
Skip to content
feat: chain source rest sync#526

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

 Merged

tnull
merged 3 commits into

from

Jul 1, 2025
 Merged


feat: chain source rest sync
#526
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c1f27ef

prefactor: rename bitcoind_rpc to bitcoind


enigbe Jun 19, 2025
b7de5f8

prefactor: prepare client for REST interface support


enigbe Jun 30, 2025
36e4c7f

feat: support chain sourcing via REST interface


enigbe Jul 1, 2025

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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down

1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down

5 changes: 3 additions & 2 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
 "-rpcbind=0.0.0.0",
 "-rpcuser=user",
 "-rpcpassword=pass",
 "-fallbackfee=0.00001"
 "-fallbackfee=0.00001",
 "-rest"
 ]
 ports:
 - "18443:18443" # Regtest RPC port
 - "18443:18443" # Regtest REST and RPC port
 - "18444:18444" # Regtest P2P port
 networks:
 - bitcoin-electrs
Expand Down

126 changes: 112 additions & 14 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
	EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
	default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
	ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
	WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
	Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
	Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
	BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
	Esplora {
 server_url: String,
 sync_config: Option<EsploraSyncConfig>,
	},
	Electrum {
 server_url: String,
 sync_config: Option<ElectrumSyncConfig>,
	},
	Bitcoind {
 rpc_host: String,
 rpc_port: u16,
 rpc_user: String,
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: None,
 });
 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.

 &mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
 });

 self
	}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
Comment thread
enigbe marked this conversation as resolved.

	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
 );
	}

	/// 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
 &self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) {
 self.inner.write().unwrap().set_chain_source_bitcoind_rest(
 rest_host,
 rest_port,
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 );
	}

	/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
 Arc::clone(&node_metrics),
 ))
 },
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
 Arc::new(ChainSource::new_bitcoind_rpc(
 Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config,
 }) => match rest_client_config {
 Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 rest_client_config.clone(),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ))
 )),
 None => Arc::new(ChainSource::new_bitcoind_rpc(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
 rpc_password.clone(),
 Arc::clone(&wallet),
 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.
 let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
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('^' + ".*" + '
feat: chain source rest sync by enigbe · Pull Request #526 · lightningdevkit/ldk-node · GitHub
Skip to content
feat: chain source rest sync#526

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

 Merged

tnull
merged 3 commits into

from

Jul 1, 2025
 Merged


feat: chain source rest sync
#526
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c1f27ef

prefactor: rename bitcoind_rpc to bitcoind


enigbe Jun 19, 2025
b7de5f8

prefactor: prepare client for REST interface support


enigbe Jun 30, 2025
36e4c7f

feat: support chain sourcing via REST interface


enigbe Jul 1, 2025

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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down

1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down

5 changes: 3 additions & 2 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
 "-rpcbind=0.0.0.0",
 "-rpcuser=user",
 "-rpcpassword=pass",
 "-fallbackfee=0.00001"
 "-fallbackfee=0.00001",
 "-rest"
 ]
 ports:
 - "18443:18443" # Regtest RPC port
 - "18443:18443" # Regtest REST and RPC port
 - "18444:18444" # Regtest P2P port
 networks:
 - bitcoin-electrs
Expand Down

126 changes: 112 additions & 14 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
	EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
	default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
	ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
	WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
	Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
	Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
	BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
	Esplora {
 server_url: String,
 sync_config: Option<EsploraSyncConfig>,
	},
	Electrum {
 server_url: String,
 sync_config: Option<ElectrumSyncConfig>,
	},
	Bitcoind {
 rpc_host: String,
 rpc_port: u16,
 rpc_user: String,
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: None,
 });
 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.

 &mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
 });

 self
	}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
Comment thread
enigbe marked this conversation as resolved.

	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
 );
	}

	/// 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
 &self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) {
 self.inner.write().unwrap().set_chain_source_bitcoind_rest(
 rest_host,
 rest_port,
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 );
	}

	/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
 Arc::clone(&node_metrics),
 ))
 },
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
 Arc::new(ChainSource::new_bitcoind_rpc(
 Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config,
 }) => match rest_client_config {
 Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 rest_client_config.clone(),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ))
 )),
 None => Arc::new(ChainSource::new_bitcoind_rpc(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
 rpc_password.clone(),
 Arc::clone(&wallet),
 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.
 let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
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('^' + ".*" + '
feat: chain source rest sync by enigbe · Pull Request #526 · lightningdevkit/ldk-node · GitHub
Skip to content
feat: chain source rest sync#526

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

 Merged

tnull
merged 3 commits into

from

Jul 1, 2025
 Merged


feat: chain source rest sync
#526
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c1f27ef

prefactor: rename bitcoind_rpc to bitcoind


enigbe Jun 19, 2025
b7de5f8

prefactor: prepare client for REST interface support


enigbe Jun 30, 2025
36e4c7f

feat: support chain sourcing via REST interface


enigbe Jul 1, 2025

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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down

1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down

5 changes: 3 additions & 2 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
 "-rpcbind=0.0.0.0",
 "-rpcuser=user",
 "-rpcpassword=pass",
 "-fallbackfee=0.00001"
 "-fallbackfee=0.00001",
 "-rest"
 ]
 ports:
 - "18443:18443" # Regtest RPC port
 - "18443:18443" # Regtest REST and RPC port
 - "18444:18444" # Regtest P2P port
 networks:
 - bitcoin-electrs
Expand Down

126 changes: 112 additions & 14 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
	EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
	default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
	ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
	WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
	Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
	Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
	BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
	Esplora {
 server_url: String,
 sync_config: Option<EsploraSyncConfig>,
	},
	Electrum {
 server_url: String,
 sync_config: Option<ElectrumSyncConfig>,
	},
	Bitcoind {
 rpc_host: String,
 rpc_port: u16,
 rpc_user: String,
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: None,
 });
 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.

 &mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
 });

 self
	}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
Comment thread
enigbe marked this conversation as resolved.

	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
 );
	}

	/// 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
 &self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) {
 self.inner.write().unwrap().set_chain_source_bitcoind_rest(
 rest_host,
 rest_port,
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 );
	}

	/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
 Arc::clone(&node_metrics),
 ))
 },
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
 Arc::new(ChainSource::new_bitcoind_rpc(
 Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config,
 }) => match rest_client_config {
 Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 rest_client_config.clone(),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ))
 )),
 None => Arc::new(ChainSource::new_bitcoind_rpc(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
 rpc_password.clone(),
 Arc::clone(&wallet),
 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.
 let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
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); }
})();
})();
feat: chain source rest sync by enigbe · Pull Request #526 · lightningdevkit/ldk-node · GitHub
Skip to content
feat: chain source rest sync#526

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

 Merged

tnull
merged 3 commits into

from

Jul 1, 2025
 Merged


feat: chain source rest sync
#526
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
c1f27ef

prefactor: rename bitcoind_rpc to bitcoind


enigbe Jun 19, 2025
b7de5f8

prefactor: prepare client for REST interface support


enigbe Jun 30, 2025
36e4c7f

feat: support chain sourcing via REST interface


enigbe Jul 1, 2025

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@@ -35,7 +35,7 @@ lightning-net-tokio = { version = "0.1.0" }
lightning-persister = { version = "0.1.0" }
lightning-background-processor = { version = "0.1.0", features = ["futures"] }
lightning-rapid-gossip-sync = { version = "0.1.0" }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "tokio"] }
lightning-block-sync = { version = "0.1.0", features = ["rpc-client", "rest-client", "tokio"] }
lightning-transaction-sync = { version = "0.1.0", features = ["esplora-async-https", "time", "electrum"] }
lightning-liquidity = { version = "0.1.0", features = ["std"] }

Expand Down

1 change: 1 addition & 0 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -78,6 +78,7 @@ interface Builder {
	void set_chain_source_esplora(string server_url, EsploraSyncConfig? config);
	void set_chain_source_electrum(string server_url, ElectrumSyncConfig? config);
	void set_chain_source_bitcoind_rpc(string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_chain_source_bitcoind_rest(string rest_host, u16 rest_port, string rpc_host, u16 rpc_port, string rpc_user, string rpc_password);
	void set_gossip_source_p2p();
	void set_gossip_source_rgs(string rgs_server_url);
	void set_liquidity_source_lsps1(PublicKey node_id, SocketAddress address, string? token);
Expand Down

5 changes: 3 additions & 2 deletions
docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,10 +13,11 @@ services:
 "-rpcbind=0.0.0.0",
 "-rpcuser=user",
 "-rpcpassword=pass",
 "-fallbackfee=0.00001"
 "-fallbackfee=0.00001",
 "-rest"
 ]
 ports:
 - "18443:18443" # Regtest RPC port
 - "18443:18443" # Regtest REST and RPC port
 - "18444:18444" # Regtest P2P port
 networks:
 - bitcoin-electrs
Expand Down

126 changes: 112 additions & 14 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,9 @@

use crate::chain::{ChainSource, DEFAULT_ESPLORA_SERVER_URL};
use crate::config::{
	default_user_config, may_announce_channel, AnnounceError, Config, ElectrumSyncConfig,
	EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL, WALLET_KEYS_SEED_LEN,
	default_user_config, may_announce_channel, AnnounceError, BitcoindRestClientConfig, Config,
	ElectrumSyncConfig, EsploraSyncConfig, DEFAULT_LOG_FILENAME, DEFAULT_LOG_LEVEL,
	WALLET_KEYS_SEED_LEN,
};

use crate::connection::ConnectionManager;
Expand DownExpand Up@@ -84,9 +85,21 @@ const LSPS_HARDENED_CHILD_INDEX: u32 = 577;

#[derive(Debug, Clone)]
enum ChainDataSourceConfig {
	Esplora { server_url: String, sync_config: Option<EsploraSyncConfig> },
	Electrum { server_url: String, sync_config: Option<ElectrumSyncConfig> },
	BitcoindRpc { rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String },
	Esplora {
 server_url: String,
 sync_config: Option<EsploraSyncConfig>,
	},
	Electrum {
 server_url: String,
 sync_config: Option<ElectrumSyncConfig>,
	},
	Bitcoind {
 rpc_host: String,
 rpc_port: u16,
 rpc_user: String,
 rpc_password: String,
 rest_client_config: Option<BitcoindRestClientConfig>,
	},
}

#[derive(Debug, Clone)]
Expand DownExpand Up@@ -299,13 +312,48 @@ impl NodeBuilder {
 self
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &mut self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config =
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password });
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: None,
 });
 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
Comment thread
enigbe marked this conversation as resolved.

 &mut self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) -> &mut Self {
 self.chain_data_source_config = Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config: Some(BitcoindRestClientConfig { rest_host, rest_port }),
 });

 self
	}

Expand DownExpand Up@@ -716,8 +764,14 @@ impl ArcedNodeBuilder {
 self.inner.write().unwrap().set_chain_source_electrum(server_url, sync_config);
	}

	/// Configures the [`Node`] instance to source its chain data from the given Bitcoin Core RPC
	/// endpoint.
	/// 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
Comment thread
enigbe marked this conversation as resolved.

	/// transaction broadcasting and chain data synchronization.
	///
	/// ## Parameters:
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection.
	pub fn set_chain_source_bitcoind_rpc(
 &self, rpc_host: String, rpc_port: u16, rpc_user: String, rpc_password: String,
	) {
Expand All@@ -729,6 +783,29 @@ impl ArcedNodeBuilder {
 );
	}

	/// 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
	/// additional RPC configuration to non-REST-supported API calls like transaction broadcasting.
	///
	/// ## Parameters:
	/// * `rest_host`, `rest_port` - Required parameters for the Bitcoin Core REST connection.
	/// * `rpc_host`, `rpc_port`, `rpc_user`, `rpc_password` - Required parameters for the Bitcoin Core RPC
	/// connection
	pub fn set_chain_source_bitcoind_rest(
 &self, rest_host: String, rest_port: u16, rpc_host: String, rpc_port: u16,
 rpc_user: String, rpc_password: String,
	) {
 self.inner.write().unwrap().set_chain_source_bitcoind_rest(
 rest_host,
 rest_port,
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 );
	}

	/// 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@@ -1068,8 +1145,14 @@ fn build_with_store_internal(
 Arc::clone(&node_metrics),
 ))
 },
 Some(ChainDataSourceConfig::BitcoindRpc { rpc_host, rpc_port, rpc_user, rpc_password }) => {
 Arc::new(ChainSource::new_bitcoind_rpc(
 Some(ChainDataSourceConfig::Bitcoind {
 rpc_host,
 rpc_port,
 rpc_user,
 rpc_password,
 rest_client_config,
 }) => match rest_client_config {
 Some(rest_client_config) => Arc::new(ChainSource::new_bitcoind_rest(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
Expand All@@ -1079,10 +1162,25 @@ fn build_with_store_internal(
 Arc::clone(&tx_broadcaster),
 Arc::clone(&kv_store),
 Arc::clone(&config),
 rest_client_config.clone(),
 Arc::clone(&logger),
 Arc::clone(&node_metrics),
 ))
 )),
 None => Arc::new(ChainSource::new_bitcoind_rpc(
 rpc_host.clone(),
 *rpc_port,
 rpc_user.clone(),
 rpc_password.clone(),
 Arc::clone(&wallet),
 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.
 let server_url = DEFAULT_ESPLORA_SERVER_URL.to_string();
Expand Down
Loading