Skip to content

wasm: Route clock reads through a time module #1122

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

Open
benthecarman wants to merge 5 commits into
base: main
Choose a base branch
from
Open

wasm: Route clock reads through a time module #1122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
47d420e
Centralize clock reads in a time module
benthecarman Oct 1, 2026
7ce676a
Use explicit time in dependency APIs
benthecarman Oct 1, 2026
7a69cd5
Gate LDK std behind an ldk-std feature
benthecarman Oct 1, 2026
512f1fb
Gate the tokio peer transport behind a feature
benthecarman Oct 1, 2026
f89930d
Update clippy MSRV to 1.85
benthecarman Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion .clippy.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
msrv = "1.63.0"
msrv = "1.85.0"

# Keep library clock reads behind src/time.rs so they work on wasm32. Tokio's runtime timers
# are separate.
disallowed-methods = [
{ path = "std::time::SystemTime::now", reason = "use crate::time instead" },
{ path = "std::time::SystemTime::elapsed", reason = "use crate::time instead" },
{ path = "std::time::Instant::now", reason = "use crate::time::Instant instead" },
{ path = "std::time::Instant::elapsed", reason = "use crate::time::Instant instead" },
{ path = "tokio::time::Instant::now", reason = "use crate::time::Instant for clock reads; runtime timers remain separate" },
{ path = "tokio::time::Instant::elapsed", reason = "use crate::time::Instant for elapsed measurements" },
{ path = "chrono::Utc::now", reason = "use crate::time::now_utc instead", allow-invalid = true },
{ path = "chrono::Local::now", reason = "use crate::time::now_utc instead", allow-invalid = true },
# Dependency APIs that read the platform clock internally. Use their explicit-time variants.
{ path = "bdk_wallet::Wallet::start_full_scan", reason = "use start_full_scan_at with crate::time" },
{ path = "bdk_wallet::Wallet::start_sync_with_revealed_spks", reason = "use start_sync_with_revealed_spks_at with crate::time" },
{ path = "lightning_liquidity::LiquidityManager::new", reason = "use new_with_custom_time_provider with crate::time::LdkTimeProvider" },
{ path = "lightning_invoice::InvoiceBuilder::current_timestamp", reason = "use duration_since_epoch with crate::time" },
{ path = "lightning_invoice::Bolt11Invoice::is_expired", reason = "use would_expire with crate::time" },
{ path = "lightning_invoice::Bolt11Invoice::duration_until_expiry", reason = "use expiration_remaining_from_epoch with crate::time" },
{ path = "lightning::offers::offer::Offer::is_expired", reason = "use is_expired_no_std with crate::time" },
{ path = "lightning::offers::refund::Refund::is_expired", reason = "use is_expired_no_std with crate::time" },
{ path = "lightning::offers::invoice::Bolt12Invoice::is_expired", reason = "use is_expired_no_std with crate::time" },
{ path = "lightning::offers::static_invoice::StaticInvoice::is_expired", reason = "use is_expired_no_std with crate::time" },
{ path = "lightning::offers::invoice_request::InvoiceRequest::respond_with", reason = "use respond_with_no_std with crate::time" },
{ path = "lightning::offers::invoice_request::VerifiedInvoiceRequest::respond_with", reason = "use respond_with_no_std with crate::time" },
{ path = "lightning::offers::invoice_request::VerifiedInvoiceRequest::respond_using_derived_keys", reason = "use respond_using_derived_keys_no_std with crate::time" },
{ path = "lightning::offers::refund::Refund::respond_with", reason = "use respond_with_no_std with crate::time" },
{ path = "lightning::offers::refund::Refund::respond_using_derived_keys", reason = "use respond_using_derived_keys_no_std with crate::time" },
{ path = "lightning_rapid_gossip_sync::RapidGossipSync::update_network_graph", reason = "use update_network_graph_no_std with Some(crate::time::unix_time_secs().expect(...)) to retain freshness validation" },
{ path = "lightning_rapid_gossip_sync::RapidGossipSync::sync_network_graph_with_file_path", reason = "read the snapshot and use update_network_graph_no_std with current time" },
{ path = "lightning::routing::gossip::NetworkGraph::remove_stale_channels_and_tracking", reason = "use remove_stale_channels_and_tracking_with_time with crate::time" },
{ path = "bdk_chain::bdk_core::spk_client::SyncRequest::builder", reason = "use builder_at with crate::time" },
{ path = "bdk_chain::bdk_core::spk_client::FullScanRequest::builder", reason = "use builder_at with crate::time" },
]
27 changes: 27 additions & 0 deletions .github/workflows/rust.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,33 @@ jobs:
cargo clippy --lib --verbose --color always -- -A warnings -D clippy::unwrap_used -A clippy::tabs_in_doc_comments
cargo clippy --lib --no-default-features --features uniffi-default --verbose --color always -- -A warnings -D clippy::unwrap_used -A clippy::tabs_in_doc_comments

clock-boundary:
name: Clock boundary
timeout-minutes: 120
runs-on: self-hosted
steps:
- name: Checkout source code
uses: actions/checkout@v4
- name: Install Rust stable toolchain
run: |
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile=minimal --default-toolchain stable
- name: Add clippy component
run: rustup component add clippy
# Clock reads must go through `src/time.rs` so they work on wasm32. See `.clippy.toml`.
- name: Ban direct clock reads in library code
run: |
cargo clippy --lib --verbose --color always -- -A warnings -D clippy::disallowed_methods
cargo clippy --lib --no-default-features --features uniffi-default --verbose --color always -- -A warnings -D clippy::disallowed_methods
cargo clippy --lib --no-default-features --features chain-esplora,storage-sqlite --verbose --color always -- -A warnings -D clippy::disallowed_methods
# LDK's `std` and `time` features read the system clock internally.
- name: Check LDK clock features are disabled without ldk-std
run: |
features=$(cargo tree --target wasm32-unknown-unknown --no-default-features -e normal --prefix none --format '{p} {f}')
if grep -E '^lightning' <<< "$features" | grep -E '\b(std|time)\b'; then
echo "LDK std or time features are enabled without ldk-std"
exit 1
fi

doc:
name: Documentation
timeout-minutes: 120
Expand Down
41 changes: 30 additions & 11 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ panic = 'abort' # Abort on panic

[features]
default = [
"ldk-std",
"net-tokio",
"chain-esplora",
"chain-electrum",
"chain-bitcoind",
Expand All @@ -37,23 +39,38 @@ default = [
"storage-vss",
"unified-payments",
]
# LDK's `std` feature reads the system clock internally. Disable it for wasm32, where clock reads
# must go through `crate::time` and LDK's explicit-time APIs instead. Features whose LDK crates
# require `std` enable this.
ldk-std = [

@tnull tnull Oct 26, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Not a big fan of this feature. I think before we move forward it would be better to refactor upstream so we can plug a custom TimeProvider everywhere or consistenly discern std and time features so we can just not set the latter here. (cc @TheBlueMatt thoughts?)

"lightning/std",
"lightning-invoice/std",
"lightning-liquidity/std",
"lightning-liquidity/time",
"lightning-background-processor/std",
"lightning-rapid-gossip-sync/std",
]
# Tokio TCP transport for peer connections. Without it, connecting to peers fails and listening
# addresses are rejected.
net-tokio = ["dep:lightning-net-tokio"]
chain-esplora = [
"ldk-std",
"dep:bdk_esplora",
"dep:esplora-client",
"dep:ldk-esplora-client",
"dep:lightning-transaction-sync",
"lightning-transaction-sync/esplora-async-https",
"lightning-transaction-sync/time",
]
chain-electrum = [
"ldk-std",
"dep:bdk_electrum",
"dep:electrum-client",
"dep:lightning-transaction-sync",
"lightning-transaction-sync/electrum-rustls-ring",
]
chain-bitcoind = ["dep:lightning-block-sync"]
chain-bitcoind = ["ldk-std", "dep:lightning-block-sync"]
storage-sqlite = ["dep:rusqlite"]
storage-filesystem = ["dep:lightning-persister"]
storage-filesystem = ["ldk-std", "dep:lightning-persister"]
storage-vss = ["dep:vss-client", "dep:prost"]
storage-postgres = ["dep:tokio-postgres", "dep:native-tls", "dep:postgres-native-tls"]
storage-postgres-vendored-tls = ["storage-postgres", "native-tls/vendored"]
Expand All @@ -65,6 +82,7 @@ unified-payments = [
uniffi = ["dep:uniffi"]
uniffi-default = [
"uniffi",
"net-tokio",
"chain-esplora",
"chain-electrum",
"storage-sqlite",
Expand All @@ -86,16 +104,17 @@ uniffi-default = [
#lightning-macros = { version = "0.2.0" }
#lightning-dns-resolver = { version = "0.3.0" }

lightning = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", features = ["std"] }
lightning = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", default-features = false, features = ["grind_signatures"] }
lightning-types = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5" }
lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", features = ["std"] }
lightning-net-tokio = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5" }
lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", default-features = false }
lightning-net-tokio = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", optional = true }
lightning-persister = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", features = ["tokio"], optional = true }
lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5" }
lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5" }
lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", default-features = false }
lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", default-features = false }
lightning-block-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", features = ["rest-client", "rpc-client", "tokio"], optional = true }
lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", optional = true }
lightning-liquidity = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", features = ["std"] }
# Measure sync durations in the node's time module, not the dependency's `time` feature.
lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", default-features = false, optional = true }
lightning-liquidity = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", default-features = false }
lightning-macros = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5" }
lightning-dns-resolver = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "d7a980641c6325ddda5072a0f470ef8392676cf5", optional = true }

Expand All @@ -113,7 +132,7 @@ bip21 = { version = "0.5", features = ["std"], default-features = false, optiona

base64 = { version = "0.22.1", default-features = false, features = ["std"] }
getrandom = { version = "0.3", default-features = false }
chrono = { version = "0.4", default-features = false, features = ["clock"] }
chrono = { version = "0.4", default-features = false, features = ["alloc"] }
tokio = { version = "1.39", default-features = false, features = [ "rt-multi-thread", "time", "sync", "macros", "net" ] }
tokio-util = { version = "0.7.10", default-features = false, features = ["rt"] }
esplora-client = { version = "0.12", default-features = false, features = ["tokio", "async-https-rustls"], optional = true }
Expand Down
Loading
Loading