Skip to content

Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into from
Aug 18, 2025
Merged

Introduce Runtime object allowng to detect outer runtime context #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions bindings/ldk_node.udl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
"InvalidListeningAddresses",
"InvalidAnnouncementAddresses",
"InvalidNodeAlias",
"RuntimeSetupFailed",
"ReadFailed",
"WriteFailed",
"StoragePathAccessFailed",
Expand Down
44 changes: 41 additions & 3 deletions src/builder.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
InvalidAnnouncementAddresses,
/// The provided alias is invalid.
InvalidNodeAlias,
/// An attempt to setup a runtime has failed.
RuntimeSetupFailed,
/// We failed to read data from the [`KVStore`].
///
/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
Self::InvalidAnnouncementAddresses => {
write!(f, "Given announcement addresses are invalid.")
},
Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
Self::ReadFailed => write!(f, "Failed to read from store."),
Self::WriteFailed => write!(f, "Failed to write to store."),
Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
gossip_source_config: Option<GossipSourceConfig>,
liquidity_source_config: Option<LiquiditySourceConfig>,
log_writer_config: Option<LogWriterConfig>,
runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
let gossip_source_config = None;
let liquidity_source_config = None;
let log_writer_config = None;
let runtime_handle = None;
Self {
config,
entropy_source_config,
chain_data_source_config,
gossip_source_config,
liquidity_source_config,
log_writer_config,
runtime_handle,
}
}

/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
///
/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
/// can detect.
#[cfg_attr(feature = "uniffi", allow(dead_code))]
pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
self.runtime_handle = Some(runtime_handle);
self
}

/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
///
/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
) -> Result<Node, BuildError> {
let logger = setup_logger(&self.log_writer_config, &self.config)?;

let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
Arc::new(Runtime::with_handle(handle.clone()))
} else {
Arc::new(Runtime::new().map_err(|e| {
log_error!(logger, "Failed to setup tokio runtime: {}", e);
BuildError::RuntimeSetupFailed
})?)
};

let seed_bytes = seed_bytes_from_config(
&self.config,
self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
self.gossip_source_config.as_ref(),
self.liquidity_source_config.as_ref(),
seed_bytes,
runtime,
logger,
Arc::new(vss_store),
)
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
let logger = setup_logger(&self.log_writer_config, &self.config)?;

let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
Arc::new(Runtime::with_handle(handle.clone()))
} else {
Arc::new(Runtime::new().map_err(|e| {
log_error!(logger, "Failed to setup tokio runtime: {}", e);
BuildError::RuntimeSetupFailed
})?)
};

@joostjagerjoostjagerMay 23, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity

@tnulltnullMay 23, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.

@joostjagerjoostjagerMay 23, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.

Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.


let seed_bytes = seed_bytes_from_config(
&self.config,
self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
self.gossip_source_config.as_ref(),
self.liquidity_source_config.as_ref(),
seed_bytes,
runtime,
logger,
kv_store,
)
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
gossip_source_config: Option<&GossipSourceConfig>,
liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
},
};

let runtime = Arc::new(RwLock::new(None));

// Initialize the ChainMonitor
let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
let background_tasks = Mutex::new(None);
let cancellable_background_tasks = Mutex::new(None);

let is_running = Arc::new(RwLock::new(false));

@TheBlueMattTheBlueMattAug 17, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.

@tnulltnullAug 18, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.


Ok(Node {
runtime,
stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
scorer,
peer_store,
payment_store,
is_running,
is_listening,
node_metrics,
})
Expand Down
11 changes: 5 additions & 6 deletions src/chain/electrum.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
}
}

pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
self.electrum_runtime_status.write().unwrap().start(
self.server_url.clone(),
Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
}

pub(super) fn start(
&mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
&mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
logger: Arc<Logger>,
) -> Result<(), Error> {
match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
electrum_client: Arc<ElectrumClient>,
bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
runtime: Arc<tokio::runtime::Runtime>,
runtime: Arc<Runtime>,
config: Arc<Config>,
logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
fn new(
server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
logger: Arc<Logger>,
server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
) -> Result<Self, Error> {
let electrum_config = ElectrumConfigBuilder::new()
.retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

let spawn_fut =
self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

let timeout_fut =
tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down
3 changes: 2 additions & 1 deletion src/chain/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
Self { kind, tx_broadcaster, logger }
}

pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
match &self.kind {
ChainSourceKind::Electrum(electrum_chain_source) => {
electrum_chain_source.start(runtime)?
Expand Down
69 changes: 32 additions & 37 deletions src/event.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
payment_store: Arc<PaymentStore>,
peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
runtime: Arc<Runtime>,
logger: L,
config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
logger: L, config: Arc<Config>,
) -> Self {
Self {
event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
let forwarding_channel_manager = self.channel_manager.clone();
let min = time_forwardable.as_millis() as u64;

let runtime_lock = self.runtime.read().unwrap();
debug_assert!(runtime_lock.is_some());
let future = async move {
Comment thread
joostjager marked this conversation as resolved.
let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

if let Some(runtime) = runtime_lock.as_ref() {
runtime.spawn(async move {
let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
forwarding_channel_manager.process_pending_htlc_forwards();
};

forwarding_channel_manager.process_pending_htlc_forwards();
});
}
self.runtime.spawn(future);
},
LdkEvent::SpendableOutputs { outputs, channel_id } => {
match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
},
LdkEvent::ConnectionNeeded { node_id, addresses } => {
let runtime_lock = self.runtime.read().unwrap();
debug_assert!(runtime_lock.is_some());

if let Some(runtime) = runtime_lock.as_ref() {
let spawn_logger = self.logger.clone();
let spawn_cm = Arc::clone(&self.connection_manager);
runtime.spawn(async move {
for addr in &addresses {
match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
Ok(()) => {
return;
},
Err(e) => {
log_error!(
spawn_logger,
"Failed to establish connection to peer {}@{}: {}",
node_id,
addr,
e
);
},
}
let spawn_logger = self.logger.clone();
let spawn_cm = Arc::clone(&self.connection_manager);
let future = async move {
for addr in &addresses {
match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
Ok(()) => {
return;
},
Err(e) => {
log_error!(
spawn_logger,
"Failed to establish connection to peer {}@{}: {}",
node_id,
addr,
e
);
},
}
});
}
}
};
self.runtime.spawn(future);
},
LdkEvent::BumpTransaction(bte) => {
match bte {
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" + '
Introduce `Runtime` object allowng to detect outer runtime context by tnull · Pull Request #543 · lightningdevkit/ldk-node · GitHub
Skip to content
Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into

from

Aug 18, 2025
 Merged


Introduce Runtime object allowng to detect outer runtime context
#543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 4 additions & 3 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
	"InvalidListeningAddresses",
	"InvalidAnnouncementAddresses",
	"InvalidNodeAlias",
	"RuntimeSetupFailed",
	"ReadFailed",
	"WriteFailed",
	"StoragePathAccessFailed",
Expand Down

44 changes: 41 additions & 3 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
	InvalidAnnouncementAddresses,
	/// The provided alias is invalid.
	InvalidNodeAlias,
	/// An attempt to setup a runtime has failed.
	RuntimeSetupFailed,
	/// We failed to read data from the [`KVStore`].
	///
	/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
 Self::InvalidAnnouncementAddresses => {
 write!(f, "Given announcement addresses are invalid.")
 },
 Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
 Self::ReadFailed => write!(f, "Failed to read from store."),
 Self::WriteFailed => write!(f, "Failed to write to store."),
 Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
	runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
 let runtime_handle = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
 runtime_handle,
 }
	}

	/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
	///
	/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
	/// can detect.
	#[cfg_attr(feature = "uniffi", allow(dead_code))]
	pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
 self.runtime_handle = Some(runtime_handle);
 self
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
	///
	/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
	) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 Arc::new(vss_store),
 )
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
	pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };
@joostjagerjoostjagerMay 23, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity
@tnulltnullMay 23, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.
@joostjagerjoostjagerMay 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.
Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 kv_store,
 )
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
 },
	};

	let runtime = Arc::new(RwLock::new(None));

	// Initialize the ChainMonitor
	let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	let is_running = Arc::new(RwLock::new(false));
@TheBlueMattTheBlueMattAug 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.
@tnulltnullAug 18, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.

	Ok(Node {
 runtime,
 stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
 scorer,
 peer_store,
 payment_store,
 is_running,
 is_listening,
 node_metrics,
	})
Expand Down

11 changes: 5 additions & 6 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
 }
	}

	pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 self.electrum_runtime_status.write().unwrap().start(
 self.server_url.clone(),
 Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
	}

	pub(super) fn start(
 &mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 &mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
	) -> Result<(), Error> {
 match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
	electrum_client: Arc<ElectrumClient>,
	bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
	tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
	runtime: Arc<tokio::runtime::Runtime>,
	runtime: Arc<Runtime>,
	config: Arc<Config>,
	logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
	fn new(
 server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
 server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
	) -> Result<Self, Error> {
 let electrum_config = ElectrumConfigBuilder::new()
 .retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

 let spawn_fut =
 self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

 let timeout_fut =
 tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down

3 changes: 2 additions & 1 deletion
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
 Self { kind, tx_broadcaster, logger }
	}

	pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 match &self.kind {
 ChainSourceKind::Electrum(electrum_chain_source) => {
 electrum_chain_source.start(runtime)?
Expand Down

69 changes: 32 additions & 37 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
	liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
	payment_store: Arc<PaymentStore>,
	peer_store: Arc<PeerStore<L>>,
	runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
	runtime: Arc<Runtime>,
	logger: L,
	config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
 channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
 output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
 liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
 logger: L, config: Arc<Config>,
	) -> Self {
 Self {
 event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
 let forwarding_channel_manager = self.channel_manager.clone();
 let min = time_forwardable.as_millis() as u64;

 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());
 let future = async move {
Comment thread
joostjager marked this conversation as resolved.

 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

 if let Some(runtime) = runtime_lock.as_ref() {
 runtime.spawn(async move {
 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 forwarding_channel_manager.process_pending_htlc_forwards();
 };

 forwarding_channel_manager.process_pending_htlc_forwards();
 });
 }
 self.runtime.spawn(future);
 },
 LdkEvent::SpendableOutputs { outputs, channel_id } => {
 match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
 debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
 },
 LdkEvent::ConnectionNeeded { node_id, addresses } => {
 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());

 if let Some(runtime) = runtime_lock.as_ref() {
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 runtime.spawn(async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 let future = async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 });
 }
 }
 };
 self.runtime.spawn(future);
 },
 LdkEvent::BumpTransaction(bte) => {
 match bte {
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('^' + ".*" + '
Introduce `Runtime` object allowng to detect outer runtime context by tnull · Pull Request #543 · lightningdevkit/ldk-node · GitHub
Skip to content
Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into

from

Aug 18, 2025
 Merged


Introduce Runtime object allowng to detect outer runtime context
#543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 4 additions & 3 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
	"InvalidListeningAddresses",
	"InvalidAnnouncementAddresses",
	"InvalidNodeAlias",
	"RuntimeSetupFailed",
	"ReadFailed",
	"WriteFailed",
	"StoragePathAccessFailed",
Expand Down

44 changes: 41 additions & 3 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
	InvalidAnnouncementAddresses,
	/// The provided alias is invalid.
	InvalidNodeAlias,
	/// An attempt to setup a runtime has failed.
	RuntimeSetupFailed,
	/// We failed to read data from the [`KVStore`].
	///
	/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
 Self::InvalidAnnouncementAddresses => {
 write!(f, "Given announcement addresses are invalid.")
 },
 Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
 Self::ReadFailed => write!(f, "Failed to read from store."),
 Self::WriteFailed => write!(f, "Failed to write to store."),
 Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
	runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
 let runtime_handle = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
 runtime_handle,
 }
	}

	/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
	///
	/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
	/// can detect.
	#[cfg_attr(feature = "uniffi", allow(dead_code))]
	pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
 self.runtime_handle = Some(runtime_handle);
 self
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
	///
	/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
	) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 Arc::new(vss_store),
 )
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
	pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };
@joostjagerjoostjagerMay 23, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity
@tnulltnullMay 23, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.
@joostjagerjoostjagerMay 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.
Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 kv_store,
 )
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
 },
	};

	let runtime = Arc::new(RwLock::new(None));

	// Initialize the ChainMonitor
	let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	let is_running = Arc::new(RwLock::new(false));
@TheBlueMattTheBlueMattAug 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.
@tnulltnullAug 18, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.

	Ok(Node {
 runtime,
 stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
 scorer,
 peer_store,
 payment_store,
 is_running,
 is_listening,
 node_metrics,
	})
Expand Down

11 changes: 5 additions & 6 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
 }
	}

	pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 self.electrum_runtime_status.write().unwrap().start(
 self.server_url.clone(),
 Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
	}

	pub(super) fn start(
 &mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 &mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
	) -> Result<(), Error> {
 match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
	electrum_client: Arc<ElectrumClient>,
	bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
	tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
	runtime: Arc<tokio::runtime::Runtime>,
	runtime: Arc<Runtime>,
	config: Arc<Config>,
	logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
	fn new(
 server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
 server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
	) -> Result<Self, Error> {
 let electrum_config = ElectrumConfigBuilder::new()
 .retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

 let spawn_fut =
 self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

 let timeout_fut =
 tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down

3 changes: 2 additions & 1 deletion
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
 Self { kind, tx_broadcaster, logger }
	}

	pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 match &self.kind {
 ChainSourceKind::Electrum(electrum_chain_source) => {
 electrum_chain_source.start(runtime)?
Expand Down

69 changes: 32 additions & 37 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
	liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
	payment_store: Arc<PaymentStore>,
	peer_store: Arc<PeerStore<L>>,
	runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
	runtime: Arc<Runtime>,
	logger: L,
	config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
 channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
 output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
 liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
 logger: L, config: Arc<Config>,
	) -> Self {
 Self {
 event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
 let forwarding_channel_manager = self.channel_manager.clone();
 let min = time_forwardable.as_millis() as u64;

 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());
 let future = async move {
Comment thread
joostjager marked this conversation as resolved.

 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

 if let Some(runtime) = runtime_lock.as_ref() {
 runtime.spawn(async move {
 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 forwarding_channel_manager.process_pending_htlc_forwards();
 };

 forwarding_channel_manager.process_pending_htlc_forwards();
 });
 }
 self.runtime.spawn(future);
 },
 LdkEvent::SpendableOutputs { outputs, channel_id } => {
 match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
 debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
 },
 LdkEvent::ConnectionNeeded { node_id, addresses } => {
 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());

 if let Some(runtime) = runtime_lock.as_ref() {
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 runtime.spawn(async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 let future = async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 });
 }
 }
 };
 self.runtime.spawn(future);
 },
 LdkEvent::BumpTransaction(bte) => {
 match bte {
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('^' + ".*" + '
Introduce `Runtime` object allowng to detect outer runtime context by tnull · Pull Request #543 · lightningdevkit/ldk-node · GitHub
Skip to content
Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into

from

Aug 18, 2025
 Merged


Introduce Runtime object allowng to detect outer runtime context
#543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 4 additions & 3 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
	"InvalidListeningAddresses",
	"InvalidAnnouncementAddresses",
	"InvalidNodeAlias",
	"RuntimeSetupFailed",
	"ReadFailed",
	"WriteFailed",
	"StoragePathAccessFailed",
Expand Down

44 changes: 41 additions & 3 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
	InvalidAnnouncementAddresses,
	/// The provided alias is invalid.
	InvalidNodeAlias,
	/// An attempt to setup a runtime has failed.
	RuntimeSetupFailed,
	/// We failed to read data from the [`KVStore`].
	///
	/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
 Self::InvalidAnnouncementAddresses => {
 write!(f, "Given announcement addresses are invalid.")
 },
 Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
 Self::ReadFailed => write!(f, "Failed to read from store."),
 Self::WriteFailed => write!(f, "Failed to write to store."),
 Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
	runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
 let runtime_handle = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
 runtime_handle,
 }
	}

	/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
	///
	/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
	/// can detect.
	#[cfg_attr(feature = "uniffi", allow(dead_code))]
	pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
 self.runtime_handle = Some(runtime_handle);
 self
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
	///
	/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
	) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 Arc::new(vss_store),
 )
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
	pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };
@joostjagerjoostjagerMay 23, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity
@tnulltnullMay 23, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.
@joostjagerjoostjagerMay 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.
Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 kv_store,
 )
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
 },
	};

	let runtime = Arc::new(RwLock::new(None));

	// Initialize the ChainMonitor
	let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	let is_running = Arc::new(RwLock::new(false));
@TheBlueMattTheBlueMattAug 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.
@tnulltnullAug 18, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.

	Ok(Node {
 runtime,
 stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
 scorer,
 peer_store,
 payment_store,
 is_running,
 is_listening,
 node_metrics,
	})
Expand Down

11 changes: 5 additions & 6 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
 }
	}

	pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 self.electrum_runtime_status.write().unwrap().start(
 self.server_url.clone(),
 Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
	}

	pub(super) fn start(
 &mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 &mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
	) -> Result<(), Error> {
 match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
	electrum_client: Arc<ElectrumClient>,
	bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
	tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
	runtime: Arc<tokio::runtime::Runtime>,
	runtime: Arc<Runtime>,
	config: Arc<Config>,
	logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
	fn new(
 server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
 server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
	) -> Result<Self, Error> {
 let electrum_config = ElectrumConfigBuilder::new()
 .retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

 let spawn_fut =
 self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

 let timeout_fut =
 tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down

3 changes: 2 additions & 1 deletion
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
 Self { kind, tx_broadcaster, logger }
	}

	pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 match &self.kind {
 ChainSourceKind::Electrum(electrum_chain_source) => {
 electrum_chain_source.start(runtime)?
Expand Down

69 changes: 32 additions & 37 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
	liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
	payment_store: Arc<PaymentStore>,
	peer_store: Arc<PeerStore<L>>,
	runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
	runtime: Arc<Runtime>,
	logger: L,
	config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
 channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
 output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
 liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
 logger: L, config: Arc<Config>,
	) -> Self {
 Self {
 event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
 let forwarding_channel_manager = self.channel_manager.clone();
 let min = time_forwardable.as_millis() as u64;

 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());
 let future = async move {
Comment thread
joostjager marked this conversation as resolved.

 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

 if let Some(runtime) = runtime_lock.as_ref() {
 runtime.spawn(async move {
 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 forwarding_channel_manager.process_pending_htlc_forwards();
 };

 forwarding_channel_manager.process_pending_htlc_forwards();
 });
 }
 self.runtime.spawn(future);
 },
 LdkEvent::SpendableOutputs { outputs, channel_id } => {
 match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
 debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
 },
 LdkEvent::ConnectionNeeded { node_id, addresses } => {
 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());

 if let Some(runtime) = runtime_lock.as_ref() {
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 runtime.spawn(async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 let future = async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 });
 }
 }
 };
 self.runtime.spawn(future);
 },
 LdkEvent::BumpTransaction(bte) => {
 match bte {
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" + '
Introduce `Runtime` object allowng to detect outer runtime context by tnull · Pull Request #543 · lightningdevkit/ldk-node · GitHub
Skip to content
Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into

from

Aug 18, 2025
 Merged


Introduce Runtime object allowng to detect outer runtime context
#543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 4 additions & 3 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
	"InvalidListeningAddresses",
	"InvalidAnnouncementAddresses",
	"InvalidNodeAlias",
	"RuntimeSetupFailed",
	"ReadFailed",
	"WriteFailed",
	"StoragePathAccessFailed",
Expand Down

44 changes: 41 additions & 3 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
	InvalidAnnouncementAddresses,
	/// The provided alias is invalid.
	InvalidNodeAlias,
	/// An attempt to setup a runtime has failed.
	RuntimeSetupFailed,
	/// We failed to read data from the [`KVStore`].
	///
	/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
 Self::InvalidAnnouncementAddresses => {
 write!(f, "Given announcement addresses are invalid.")
 },
 Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
 Self::ReadFailed => write!(f, "Failed to read from store."),
 Self::WriteFailed => write!(f, "Failed to write to store."),
 Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
	runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
 let runtime_handle = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
 runtime_handle,
 }
	}

	/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
	///
	/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
	/// can detect.
	#[cfg_attr(feature = "uniffi", allow(dead_code))]
	pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
 self.runtime_handle = Some(runtime_handle);
 self
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
	///
	/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
	) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 Arc::new(vss_store),
 )
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
	pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };
@joostjagerjoostjagerMay 23, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity
@tnulltnullMay 23, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.
@joostjagerjoostjagerMay 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.
Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 kv_store,
 )
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
 },
	};

	let runtime = Arc::new(RwLock::new(None));

	// Initialize the ChainMonitor
	let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	let is_running = Arc::new(RwLock::new(false));
@TheBlueMattTheBlueMattAug 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.
@tnulltnullAug 18, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.

	Ok(Node {
 runtime,
 stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
 scorer,
 peer_store,
 payment_store,
 is_running,
 is_listening,
 node_metrics,
	})
Expand Down

11 changes: 5 additions & 6 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
 }
	}

	pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 self.electrum_runtime_status.write().unwrap().start(
 self.server_url.clone(),
 Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
	}

	pub(super) fn start(
 &mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 &mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
	) -> Result<(), Error> {
 match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
	electrum_client: Arc<ElectrumClient>,
	bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
	tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
	runtime: Arc<tokio::runtime::Runtime>,
	runtime: Arc<Runtime>,
	config: Arc<Config>,
	logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
	fn new(
 server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
 server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
	) -> Result<Self, Error> {
 let electrum_config = ElectrumConfigBuilder::new()
 .retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

 let spawn_fut =
 self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

 let timeout_fut =
 tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down

3 changes: 2 additions & 1 deletion
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
 Self { kind, tx_broadcaster, logger }
	}

	pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 match &self.kind {
 ChainSourceKind::Electrum(electrum_chain_source) => {
 electrum_chain_source.start(runtime)?
Expand Down

69 changes: 32 additions & 37 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
	liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
	payment_store: Arc<PaymentStore>,
	peer_store: Arc<PeerStore<L>>,
	runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
	runtime: Arc<Runtime>,
	logger: L,
	config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
 channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
 output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
 liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
 logger: L, config: Arc<Config>,
	) -> Self {
 Self {
 event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
 let forwarding_channel_manager = self.channel_manager.clone();
 let min = time_forwardable.as_millis() as u64;

 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());
 let future = async move {
Comment thread
joostjager marked this conversation as resolved.

 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

 if let Some(runtime) = runtime_lock.as_ref() {
 runtime.spawn(async move {
 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 forwarding_channel_manager.process_pending_htlc_forwards();
 };

 forwarding_channel_manager.process_pending_htlc_forwards();
 });
 }
 self.runtime.spawn(future);
 },
 LdkEvent::SpendableOutputs { outputs, channel_id } => {
 match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
 debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
 },
 LdkEvent::ConnectionNeeded { node_id, addresses } => {
 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());

 if let Some(runtime) = runtime_lock.as_ref() {
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 runtime.spawn(async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 let future = async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 });
 }
 }
 };
 self.runtime.spawn(future);
 },
 LdkEvent::BumpTransaction(bte) => {
 match bte {
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('^' + ".*" + '
Introduce `Runtime` object allowng to detect outer runtime context by tnull · Pull Request #543 · lightningdevkit/ldk-node · GitHub
Skip to content
Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into

from

Aug 18, 2025
 Merged


Introduce Runtime object allowng to detect outer runtime context
#543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 4 additions & 3 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
	"InvalidListeningAddresses",
	"InvalidAnnouncementAddresses",
	"InvalidNodeAlias",
	"RuntimeSetupFailed",
	"ReadFailed",
	"WriteFailed",
	"StoragePathAccessFailed",
Expand Down

44 changes: 41 additions & 3 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
	InvalidAnnouncementAddresses,
	/// The provided alias is invalid.
	InvalidNodeAlias,
	/// An attempt to setup a runtime has failed.
	RuntimeSetupFailed,
	/// We failed to read data from the [`KVStore`].
	///
	/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
 Self::InvalidAnnouncementAddresses => {
 write!(f, "Given announcement addresses are invalid.")
 },
 Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
 Self::ReadFailed => write!(f, "Failed to read from store."),
 Self::WriteFailed => write!(f, "Failed to write to store."),
 Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
	runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
 let runtime_handle = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
 runtime_handle,
 }
	}

	/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
	///
	/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
	/// can detect.
	#[cfg_attr(feature = "uniffi", allow(dead_code))]
	pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
 self.runtime_handle = Some(runtime_handle);
 self
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
	///
	/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
	) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 Arc::new(vss_store),
 )
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
	pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };
@joostjagerjoostjagerMay 23, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity
@tnulltnullMay 23, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.
@joostjagerjoostjagerMay 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.
Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 kv_store,
 )
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
 },
	};

	let runtime = Arc::new(RwLock::new(None));

	// Initialize the ChainMonitor
	let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	let is_running = Arc::new(RwLock::new(false));
@TheBlueMattTheBlueMattAug 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.
@tnulltnullAug 18, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.

	Ok(Node {
 runtime,
 stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
 scorer,
 peer_store,
 payment_store,
 is_running,
 is_listening,
 node_metrics,
	})
Expand Down

11 changes: 5 additions & 6 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
 }
	}

	pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 self.electrum_runtime_status.write().unwrap().start(
 self.server_url.clone(),
 Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
	}

	pub(super) fn start(
 &mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 &mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
	) -> Result<(), Error> {
 match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
	electrum_client: Arc<ElectrumClient>,
	bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
	tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
	runtime: Arc<tokio::runtime::Runtime>,
	runtime: Arc<Runtime>,
	config: Arc<Config>,
	logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
	fn new(
 server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
 server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
	) -> Result<Self, Error> {
 let electrum_config = ElectrumConfigBuilder::new()
 .retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

 let spawn_fut =
 self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

 let timeout_fut =
 tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down

3 changes: 2 additions & 1 deletion
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
 Self { kind, tx_broadcaster, logger }
	}

	pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 match &self.kind {
 ChainSourceKind::Electrum(electrum_chain_source) => {
 electrum_chain_source.start(runtime)?
Expand Down

69 changes: 32 additions & 37 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
	liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
	payment_store: Arc<PaymentStore>,
	peer_store: Arc<PeerStore<L>>,
	runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
	runtime: Arc<Runtime>,
	logger: L,
	config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
 channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
 output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
 liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
 logger: L, config: Arc<Config>,
	) -> Self {
 Self {
 event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
 let forwarding_channel_manager = self.channel_manager.clone();
 let min = time_forwardable.as_millis() as u64;

 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());
 let future = async move {
Comment thread
joostjager marked this conversation as resolved.

 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

 if let Some(runtime) = runtime_lock.as_ref() {
 runtime.spawn(async move {
 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 forwarding_channel_manager.process_pending_htlc_forwards();
 };

 forwarding_channel_manager.process_pending_htlc_forwards();
 });
 }
 self.runtime.spawn(future);
 },
 LdkEvent::SpendableOutputs { outputs, channel_id } => {
 match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
 debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
 },
 LdkEvent::ConnectionNeeded { node_id, addresses } => {
 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());

 if let Some(runtime) = runtime_lock.as_ref() {
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 runtime.spawn(async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 let future = async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 });
 }
 }
 };
 self.runtime.spawn(future);
 },
 LdkEvent::BumpTransaction(bte) => {
 match bte {
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('^' + ".*" + '
Introduce `Runtime` object allowng to detect outer runtime context by tnull · Pull Request #543 · lightningdevkit/ldk-node · GitHub
Skip to content
Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into

from

Aug 18, 2025
 Merged


Introduce Runtime object allowng to detect outer runtime context
#543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 4 additions & 3 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
	"InvalidListeningAddresses",
	"InvalidAnnouncementAddresses",
	"InvalidNodeAlias",
	"RuntimeSetupFailed",
	"ReadFailed",
	"WriteFailed",
	"StoragePathAccessFailed",
Expand Down

44 changes: 41 additions & 3 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
	InvalidAnnouncementAddresses,
	/// The provided alias is invalid.
	InvalidNodeAlias,
	/// An attempt to setup a runtime has failed.
	RuntimeSetupFailed,
	/// We failed to read data from the [`KVStore`].
	///
	/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
 Self::InvalidAnnouncementAddresses => {
 write!(f, "Given announcement addresses are invalid.")
 },
 Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
 Self::ReadFailed => write!(f, "Failed to read from store."),
 Self::WriteFailed => write!(f, "Failed to write to store."),
 Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
	runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
 let runtime_handle = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
 runtime_handle,
 }
	}

	/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
	///
	/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
	/// can detect.
	#[cfg_attr(feature = "uniffi", allow(dead_code))]
	pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
 self.runtime_handle = Some(runtime_handle);
 self
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
	///
	/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
	) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 Arc::new(vss_store),
 )
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
	pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };
@joostjagerjoostjagerMay 23, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity
@tnulltnullMay 23, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.
@joostjagerjoostjagerMay 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.
Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 kv_store,
 )
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
 },
	};

	let runtime = Arc::new(RwLock::new(None));

	// Initialize the ChainMonitor
	let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	let is_running = Arc::new(RwLock::new(false));
@TheBlueMattTheBlueMattAug 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.
@tnulltnullAug 18, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.

	Ok(Node {
 runtime,
 stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
 scorer,
 peer_store,
 payment_store,
 is_running,
 is_listening,
 node_metrics,
	})
Expand Down

11 changes: 5 additions & 6 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
 }
	}

	pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 self.electrum_runtime_status.write().unwrap().start(
 self.server_url.clone(),
 Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
	}

	pub(super) fn start(
 &mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 &mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
	) -> Result<(), Error> {
 match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
	electrum_client: Arc<ElectrumClient>,
	bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
	tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
	runtime: Arc<tokio::runtime::Runtime>,
	runtime: Arc<Runtime>,
	config: Arc<Config>,
	logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
	fn new(
 server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
 server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
	) -> Result<Self, Error> {
 let electrum_config = ElectrumConfigBuilder::new()
 .retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

 let spawn_fut =
 self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

 let timeout_fut =
 tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down

3 changes: 2 additions & 1 deletion
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
 Self { kind, tx_broadcaster, logger }
	}

	pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 match &self.kind {
 ChainSourceKind::Electrum(electrum_chain_source) => {
 electrum_chain_source.start(runtime)?
Expand Down

69 changes: 32 additions & 37 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
	liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
	payment_store: Arc<PaymentStore>,
	peer_store: Arc<PeerStore<L>>,
	runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
	runtime: Arc<Runtime>,
	logger: L,
	config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
 channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
 output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
 liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
 logger: L, config: Arc<Config>,
	) -> Self {
 Self {
 event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
 let forwarding_channel_manager = self.channel_manager.clone();
 let min = time_forwardable.as_millis() as u64;

 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());
 let future = async move {
Comment thread
joostjager marked this conversation as resolved.

 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

 if let Some(runtime) = runtime_lock.as_ref() {
 runtime.spawn(async move {
 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 forwarding_channel_manager.process_pending_htlc_forwards();
 };

 forwarding_channel_manager.process_pending_htlc_forwards();
 });
 }
 self.runtime.spawn(future);
 },
 LdkEvent::SpendableOutputs { outputs, channel_id } => {
 match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
 debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
 },
 LdkEvent::ConnectionNeeded { node_id, addresses } => {
 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());

 if let Some(runtime) = runtime_lock.as_ref() {
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 runtime.spawn(async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 let future = async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 });
 }
 }
 };
 self.runtime.spawn(future);
 },
 LdkEvent::BumpTransaction(bte) => {
 match bte {
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); }
})();
})();
Introduce `Runtime` object allowng to detect outer runtime context by tnull · Pull Request #543 · lightningdevkit/ldk-node · GitHub
Skip to content
Introduce Runtime object allowng to detect outer runtime context#543

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 1 commit into

from

Aug 18, 2025
 Merged


Introduce Runtime object allowng to detect outer runtime context
#543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 4 additions & 3 deletions
bindings/ldk_node.udl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ dictionary LogRecord {

[Trait, WithForeign]
interface LogWriter {
void log(LogRecord record);
void log(LogRecord record);
};

interface Builder {
Expand DownExpand Up@@ -161,8 +161,8 @@ interface Node {

[Enum]
interface Bolt11InvoiceDescription {
Hash(string hash);
Direct(string description);
Hash(string hash);
Direct(string description);
};

interface Bolt11Payment {
Expand DownExpand Up@@ -335,6 +335,7 @@ enum BuildError {
	"InvalidListeningAddresses",
	"InvalidAnnouncementAddresses",
	"InvalidNodeAlias",
	"RuntimeSetupFailed",
	"ReadFailed",
	"WriteFailed",
	"StoragePathAccessFailed",
Expand Down

44 changes: 41 additions & 3 deletions
src/builder.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ use crate::liquidity::{
use crate::logger::{log_error, log_info, LdkLogger, LogLevel, LogWriter, Logger};
use crate::message_handler::NodeCustomMessageHandler;
use crate::peer_store::PeerStore;
use crate::runtime::Runtime;
use crate::tx_broadcaster::TransactionBroadcaster;
use crate::types::{
	ChainMonitor, ChannelManager, DynStore, GossipSync, Graph, KeysManager, MessageRouter,
Expand DownExpand Up@@ -168,6 +169,8 @@ pub enum BuildError {
	InvalidAnnouncementAddresses,
	/// The provided alias is invalid.
	InvalidNodeAlias,
	/// An attempt to setup a runtime has failed.
	RuntimeSetupFailed,
	/// We failed to read data from the [`KVStore`].
	///
	/// [`KVStore`]: lightning::util::persist::KVStore
Expand DownExpand Up@@ -205,6 +208,7 @@ impl fmt::Display for BuildError {
 Self::InvalidAnnouncementAddresses => {
 write!(f, "Given announcement addresses are invalid.")
 },
 Self::RuntimeSetupFailed => write!(f, "Failed to setup a runtime."),
 Self::ReadFailed => write!(f, "Failed to read from store."),
 Self::WriteFailed => write!(f, "Failed to write to store."),
 Self::StoragePathAccessFailed => write!(f, "Failed to access the given storage path."),
Expand DownExpand Up@@ -236,6 +240,7 @@ pub struct NodeBuilder {
	gossip_source_config: Option<GossipSourceConfig>,
	liquidity_source_config: Option<LiquiditySourceConfig>,
	log_writer_config: Option<LogWriterConfig>,
	runtime_handle: Option<tokio::runtime::Handle>,
}

impl NodeBuilder {
Expand All@@ -252,16 +257,28 @@ impl NodeBuilder {
 let gossip_source_config = None;
 let liquidity_source_config = None;
 let log_writer_config = None;
 let runtime_handle = None;
 Self {
 config,
 entropy_source_config,
 chain_data_source_config,
 gossip_source_config,
 liquidity_source_config,
 log_writer_config,
 runtime_handle,
 }
	}

	/// Configures the [`Node`] instance to (re-)use a specific `tokio` runtime.
	///
	/// If not provided, the node will spawn its own runtime or reuse any outer runtime context it
	/// can detect.
	#[cfg_attr(feature = "uniffi", allow(dead_code))]
	pub fn set_runtime(&mut self, runtime_handle: tokio::runtime::Handle) -> &mut Self {
 self.runtime_handle = Some(runtime_handle);
 self
	}

	/// Configures the [`Node`] instance to source its wallet entropy from a seed file on disk.
	///
	/// If the given file does not exist a new random seed file will be generated and
Expand DownExpand Up@@ -650,6 +667,15 @@ impl NodeBuilder {
	) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand DownExpand Up@@ -678,6 +704,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 Arc::new(vss_store),
 )
Expand All@@ -687,6 +714,15 @@ impl NodeBuilder {
	pub fn build_with_store(&self, kv_store: Arc<DynStore>) -> Result<Node, BuildError> {
 let logger = setup_logger(&self.log_writer_config, &self.config)?;

 let runtime = if let Some(handle) = self.runtime_handle.as_ref() {
 Arc::new(Runtime::with_handle(handle.clone()))
 } else {
 Arc::new(Runtime::new().map_err(|e| {
 log_error!(logger, "Failed to setup tokio runtime: {}", e);
 BuildError::RuntimeSetupFailed
 })?)
 };
@joostjagerjoostjagerMay 23, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code reuse opportunity
@tnulltnullMay 23, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NACK, IMO it's much more readable to keep short blocks like this inlined, instead of having the reader jump all over the file, losing context.
@joostjagerjoostjagerMay 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree. I think eliminating the risk of future code changes not being applied in both places is more important than having the reader jump to a function. The function can have a descriptive name too such as build_runtime. I don't think it is bad for readability at all.
Your argument of jumping all over the file would also apply to code that isn't necessarily duplicated. Because also in that case, the reader would have to jump. I think that would lead to long function bodies, of which there are already too many in ldk, and those absolutely do not help with readability.

 let seed_bytes = seed_bytes_from_config(
 &self.config,
 self.entropy_source_config.as_ref(),
Expand All@@ -700,6 +736,7 @@ impl NodeBuilder {
 self.gossip_source_config.as_ref(),
 self.liquidity_source_config.as_ref(),
 seed_bytes,
 runtime,
 logger,
 kv_store,
 )
Expand DownExpand Up@@ -1049,7 +1086,7 @@ fn build_with_store_internal(
	config: Arc<Config>, chain_data_source_config: Option<&ChainDataSourceConfig>,
	gossip_source_config: Option<&GossipSourceConfig>,
	liquidity_source_config: Option<&LiquiditySourceConfig>, seed_bytes: [u8; 64],
	logger: Arc<Logger>, kv_store: Arc<DynStore>,
runtime: Arc<Runtime>, logger: Arc<Logger>, kv_store: Arc<DynStore>,
) -> Result<Node, BuildError> {
	optionally_install_rustls_cryptoprovider();

Expand DownExpand Up@@ -1241,8 +1278,6 @@ fn build_with_store_internal(
 },
	};

	let runtime = Arc::new(RwLock::new(None));

	// Initialize the ChainMonitor
	let chain_monitor: Arc<ChainMonitor> = Arc::new(chainmonitor::ChainMonitor::new(
 Some(Arc::clone(&chain_source)),
Expand DownExpand Up@@ -1637,6 +1672,8 @@ fn build_with_store_internal(
	let background_tasks = Mutex::new(None);
	let cancellable_background_tasks = Mutex::new(None);

	let is_running = Arc::new(RwLock::new(false));
@TheBlueMattTheBlueMattAug 17, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really be an AtomicBool, not a RwLock<bool>.
@tnulltnullAug 18, 2025

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we chose an RwLock for a reason, namely that we acquire and hold the lock during start/stop which keeps us from running into weird intermediate states if users would call start/stop in quick succession.

	Ok(Node {
 runtime,
 stop_sender,
Expand DownExpand Up@@ -1664,6 +1701,7 @@ fn build_with_store_internal(
 scorer,
 peer_store,
 payment_store,
 is_running,
 is_listening,
 node_metrics,
	})
Expand Down

11 changes: 5 additions & 6 deletions
src/chain/electrum.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ use crate::fee_estimator::{
};
use crate::io::utils::write_node_metrics;
use crate::logger::{log_bytes, log_error, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::NodeMetrics;

Expand DownExpand Up@@ -86,7 +87,7 @@ impl ElectrumChainSource {
 }
	}

	pub(super) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(super) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 self.electrum_runtime_status.write().unwrap().start(
 self.server_url.clone(),
 Arc::clone(&runtime),
Expand DownExpand Up@@ -339,7 +340,7 @@ impl ElectrumRuntimeStatus {
	}

	pub(super) fn start(
 &mut self, server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 &mut self, server_url: String, runtime: Arc<Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
	) -> Result<(), Error> {
 match self {
Expand DownExpand Up@@ -403,15 +404,14 @@ struct ElectrumRuntimeClient {
	electrum_client: Arc<ElectrumClient>,
	bdk_electrum_client: Arc<BdkElectrumClient<ElectrumClient>>,
	tx_sync: Arc<ElectrumSyncClient<Arc<Logger>>>,
	runtime: Arc<tokio::runtime::Runtime>,
	runtime: Arc<Runtime>,
	config: Arc<Config>,
	logger: Arc<Logger>,
}

impl ElectrumRuntimeClient {
	fn new(
 server_url: String, runtime: Arc<tokio::runtime::Runtime>, config: Arc<Config>,
 logger: Arc<Logger>,
 server_url: String, runtime: Arc<Runtime>, config: Arc<Config>, logger: Arc<Logger>,
	) -> Result<Self, Error> {
 let electrum_config = ElectrumConfigBuilder::new()
 .retry(ELECTRUM_CLIENT_NUM_RETRIES)
Expand DownExpand Up@@ -544,7 +544,6 @@ impl ElectrumRuntimeClient {

 let spawn_fut =
 self.runtime.spawn_blocking(move || electrum_client.transaction_broadcast(&tx));

 let timeout_fut =
 tokio::time::timeout(Duration::from_secs(TX_BROADCAST_TIMEOUT_SECS), spawn_fut);

Expand Down

3 changes: 2 additions & 1 deletion
src/chain/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ use crate::config::{
use crate::fee_estimator::OnchainFeeEstimator;
use crate::io::utils::write_node_metrics;
use crate::logger::{log_debug, log_info, log_trace, LdkLogger, Logger};
use crate::runtime::Runtime;
use crate::types::{Broadcaster, ChainMonitor, ChannelManager, DynStore, Sweeper, Wallet};
use crate::{Error, NodeMetrics};

Expand DownExpand Up@@ -185,7 +186,7 @@ impl ChainSource {
 Self { kind, tx_broadcaster, logger }
	}

	pub(crate) fn start(&self, runtime: Arc<tokio::runtime::Runtime>) -> Result<(), Error> {
	pub(crate) fn start(&self, runtime: Arc<Runtime>) -> Result<(), Error> {
 match &self.kind {
 ChainSourceKind::Electrum(electrum_chain_source) => {
 electrum_chain_source.start(runtime)?
Expand Down

69 changes: 32 additions & 37 deletions
src/event.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,8 @@ use crate::io::{
};
use crate::logger::{log_debug, log_error, log_info, LdkLogger};

use crate::runtime::Runtime;

use lightning::events::bump_transaction::BumpTransactionEvent;
use lightning::events::{ClosureReason, PaymentPurpose, ReplayEvent};
use lightning::events::{Event as LdkEvent, PaymentFailureReason};
Expand All@@ -53,7 +55,7 @@ use core::future::Future;
use core::task::{Poll, Waker};
use std::collections::VecDeque;
use std::ops::Deref;
use std::sync::{Arc, Condvar, Mutex, RwLock};
use std::sync::{Arc, Condvar, Mutex};
use std::time::Duration;

/// An event emitted by [`Node`], which should be handled by the user.
Expand DownExpand Up@@ -451,7 +453,7 @@ where
	liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
	payment_store: Arc<PaymentStore>,
	peer_store: Arc<PeerStore<L>>,
	runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>,
	runtime: Arc<Runtime>,
	logger: L,
	config: Arc<Config>,
}
Expand All@@ -466,8 +468,8 @@ where
 channel_manager: Arc<ChannelManager>, connection_manager: Arc<ConnectionManager<L>>,
 output_sweeper: Arc<Sweeper>, network_graph: Arc<Graph>,
 liquidity_source: Option<Arc<LiquiditySource<Arc<Logger>>>>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>,
runtime: Arc<RwLock<Option<Arc<tokio::runtime::Runtime>>>>, logger: L, config: Arc<Config>,
 payment_store: Arc<PaymentStore>, peer_store: Arc<PeerStore<L>>, runtime: Arc<Runtime>,
 logger: L, config: Arc<Config>,
	) -> Self {
 Self {
 event_queue,
Expand DownExpand Up@@ -1049,17 +1051,14 @@ where
 let forwarding_channel_manager = self.channel_manager.clone();
 let min = time_forwardable.as_millis() as u64;

 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());
 let future = async move {
Comment thread
joostjager marked this conversation as resolved.

 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;

 if let Some(runtime) = runtime_lock.as_ref() {
 runtime.spawn(async move {
 let millis_to_sleep = thread_rng().gen_range(min..min * 5) as u64;
 tokio::time::sleep(Duration::from_millis(millis_to_sleep)).await;
 forwarding_channel_manager.process_pending_htlc_forwards();
 };

 forwarding_channel_manager.process_pending_htlc_forwards();
 });
 }
 self.runtime.spawn(future);
 },
 LdkEvent::SpendableOutputs { outputs, channel_id } => {
 match self.output_sweeper.track_spendable_outputs(outputs, channel_id, true, None) {
Expand DownExpand Up@@ -1421,31 +1420,27 @@ where
 debug_assert!(false, "We currently don't handle BOLT12 invoices manually, so this event should never be emitted.");
 },
 LdkEvent::ConnectionNeeded { node_id, addresses } => {
 let runtime_lock = self.runtime.read().unwrap();
 debug_assert!(runtime_lock.is_some());

 if let Some(runtime) = runtime_lock.as_ref() {
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 runtime.spawn(async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 let spawn_logger = self.logger.clone();
 let spawn_cm = Arc::clone(&self.connection_manager);
 let future = async move {
 for addr in &addresses {
 match spawn_cm.connect_peer_if_necessary(node_id, addr.clone()).await {
 Ok(()) => {
 return;
 },
 Err(e) => {
 log_error!(
 spawn_logger,
 "Failed to establish connection to peer {}@{}: {}",
 node_id,
 addr,
 e
 );
 },
 }
 });
 }
 }
 };
 self.runtime.spawn(future);
 },
 LdkEvent::BumpTransaction(bte) => {
 match bte {
Expand Down
Loading
Loading