Skip to content

Drop background processor futures feature#3777

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
TheBlueMatt merged 1 commit into from
May 14, 2025
Merged

Drop background processor futures feature #3777

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
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
run: |
cargo install cargo-llvm-cov
export RUSTFLAGS="-Coverflow-checks=off"
cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
# Could you use this to fake the coverage report for your PR? Sure.
# Will anyone be impressed by your amazing coverage? No
# Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
- name: Run cargo check for release build.
run: |
cargo check --release
cargo check --no-default-features --features=futures,std --release
cargo check --no-default-features --features=std --release
cargo doc --release
- name: Run cargo check for Taproot build.
run: |
cargo check --release
cargo check --no-default-features --release
cargo check --no-default-features --features=futures,std --release
cargo check --no-default-features --features=std --release
cargo doc --release
cargo doc --no-default-features --release
env:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/semver.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
with:
package: lightning-background-processor
feature-group: only-explicit-features
features: futures
- name: Check lightning-block-sync SemVer
uses: obi1kenobi/cargo-semver-checks-action@v2
with:
Expand Down
7 changes: 2 additions & 5 deletions ci/ci-tests.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down
1 change: 0 additions & 1 deletion lightning-background-processor/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down
19 changes: 4 additions & 15 deletions lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
b
}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
min_u64(FRESHNESS_TIMER, PING_TIMER),
min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
use core::future::Future;
use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
feature = "std",
doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = " handle.await.unwrap()")]
/// # }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
'a,
UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
}

#[tokio::test]
#[cfg(feature = "futures")]
async fn test_channel_manager_persist_error_async() {
// Test that if we encounter an error during manager persistence, the thread panics.
let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
}

#[tokio::test]
#[cfg(feature = "futures")]
async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
}

#[tokio::test]
#[cfg(feature = "futures")]
async fn test_payment_path_scoring_async() {
let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
let event_handler = move |event: Event| {
Expand Down
2 changes: 1 addition & 1 deletion msrv-no-dev-deps-check/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }
2 changes: 1 addition & 1 deletion no-std-check/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }
, '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" + '
Drop background processor futures feature by joostjager · Pull Request #3777 · lightningdevkit/rust-lightning · GitHub
Skip to content
Drop background processor futures feature#3777

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

TheBlueMatt
merged 1 commit into

from

May 14, 2025
 Merged


Drop background processor futures feature
#3777
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


6 changes: 3 additions & 3 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
 run: |
 cargo install cargo-llvm-cov
 export RUSTFLAGS="-Coverflow-checks=off"
 cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
 cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
 # Could you use this to fake the coverage report for your PR? Sure.
 # Will anyone be impressed by your amazing coverage? No
 # Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
 - name: Run cargo check for release build.
 run: |
 cargo check --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 - name: Run cargo check for Taproot build.
 run: |
 cargo check --release
 cargo check --no-default-features --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 cargo doc --no-default-features --release
 env:
Expand Down

1 change: 0 additions & 1 deletion
.github/workflows/semver.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
 with:
 package: lightning-background-processor
 feature-group: only-explicit-features
 features: futures
 - name: Check lightning-block-sync SemVer
 uses: obi1kenobi/cargo-semver-checks-action@v2
 with:
Expand Down

7 changes: 2 additions & 5 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down

1 change: 0 additions & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down

19 changes: 4 additions & 15 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
	if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
 b
	}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
	min_u64(FRESHNESS_TIMER, PING_TIMER),
	min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
	} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
	use core::future::Future;
	use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
 unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
	}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
	feature = "std",
	doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = "	handle.await.unwrap()")]
///	# }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
	'a,
	UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_channel_manager_persist_error_async() {
 // Test that if we encounter an error during manager persistence, the thread panics.
 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_payment_path_scoring_async() {
 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
 let event_handler = move |event: Event| {
Expand Down

2 changes: 1 addition & 1 deletion
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }

2 changes: 1 addition & 1 deletion
no-std-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }

, '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('^' + ".*" + '
Drop background processor futures feature by joostjager · Pull Request #3777 · lightningdevkit/rust-lightning · GitHub
Skip to content
Drop background processor futures feature#3777

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

TheBlueMatt
merged 1 commit into

from

May 14, 2025
 Merged


Drop background processor futures feature
#3777
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


6 changes: 3 additions & 3 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
 run: |
 cargo install cargo-llvm-cov
 export RUSTFLAGS="-Coverflow-checks=off"
 cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
 cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
 # Could you use this to fake the coverage report for your PR? Sure.
 # Will anyone be impressed by your amazing coverage? No
 # Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
 - name: Run cargo check for release build.
 run: |
 cargo check --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 - name: Run cargo check for Taproot build.
 run: |
 cargo check --release
 cargo check --no-default-features --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 cargo doc --no-default-features --release
 env:
Expand Down

1 change: 0 additions & 1 deletion
.github/workflows/semver.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
 with:
 package: lightning-background-processor
 feature-group: only-explicit-features
 features: futures
 - name: Check lightning-block-sync SemVer
 uses: obi1kenobi/cargo-semver-checks-action@v2
 with:
Expand Down

7 changes: 2 additions & 5 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down

1 change: 0 additions & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down

19 changes: 4 additions & 15 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
	if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
 b
	}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
	min_u64(FRESHNESS_TIMER, PING_TIMER),
	min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
	} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
	use core::future::Future;
	use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
 unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
	}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
	feature = "std",
	doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = "	handle.await.unwrap()")]
///	# }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
	'a,
	UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_channel_manager_persist_error_async() {
 // Test that if we encounter an error during manager persistence, the thread panics.
 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_payment_path_scoring_async() {
 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
 let event_handler = move |event: Event| {
Expand Down

2 changes: 1 addition & 1 deletion
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }

2 changes: 1 addition & 1 deletion
no-std-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }

, '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('^' + ".*" + '
Drop background processor futures feature by joostjager · Pull Request #3777 · lightningdevkit/rust-lightning · GitHub
Skip to content
Drop background processor futures feature#3777

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

TheBlueMatt
merged 1 commit into

from

May 14, 2025
 Merged


Drop background processor futures feature
#3777
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


6 changes: 3 additions & 3 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
 run: |
 cargo install cargo-llvm-cov
 export RUSTFLAGS="-Coverflow-checks=off"
 cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
 cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
 # Could you use this to fake the coverage report for your PR? Sure.
 # Will anyone be impressed by your amazing coverage? No
 # Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
 - name: Run cargo check for release build.
 run: |
 cargo check --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 - name: Run cargo check for Taproot build.
 run: |
 cargo check --release
 cargo check --no-default-features --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 cargo doc --no-default-features --release
 env:
Expand Down

1 change: 0 additions & 1 deletion
.github/workflows/semver.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
 with:
 package: lightning-background-processor
 feature-group: only-explicit-features
 features: futures
 - name: Check lightning-block-sync SemVer
 uses: obi1kenobi/cargo-semver-checks-action@v2
 with:
Expand Down

7 changes: 2 additions & 5 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down

1 change: 0 additions & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down

19 changes: 4 additions & 15 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
	if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
 b
	}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
	min_u64(FRESHNESS_TIMER, PING_TIMER),
	min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
	} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
	use core::future::Future;
	use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
 unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
	}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
	feature = "std",
	doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = "	handle.await.unwrap()")]
///	# }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
	'a,
	UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_channel_manager_persist_error_async() {
 // Test that if we encounter an error during manager persistence, the thread panics.
 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_payment_path_scoring_async() {
 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
 let event_handler = move |event: Event| {
Expand Down

2 changes: 1 addition & 1 deletion
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }

2 changes: 1 addition & 1 deletion
no-std-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }

, '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" + '
Drop background processor futures feature by joostjager · Pull Request #3777 · lightningdevkit/rust-lightning · GitHub
Skip to content
Drop background processor futures feature#3777

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

TheBlueMatt
merged 1 commit into

from

May 14, 2025
 Merged


Drop background processor futures feature
#3777
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


6 changes: 3 additions & 3 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
 run: |
 cargo install cargo-llvm-cov
 export RUSTFLAGS="-Coverflow-checks=off"
 cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
 cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
 # Could you use this to fake the coverage report for your PR? Sure.
 # Will anyone be impressed by your amazing coverage? No
 # Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
 - name: Run cargo check for release build.
 run: |
 cargo check --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 - name: Run cargo check for Taproot build.
 run: |
 cargo check --release
 cargo check --no-default-features --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 cargo doc --no-default-features --release
 env:
Expand Down

1 change: 0 additions & 1 deletion
.github/workflows/semver.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
 with:
 package: lightning-background-processor
 feature-group: only-explicit-features
 features: futures
 - name: Check lightning-block-sync SemVer
 uses: obi1kenobi/cargo-semver-checks-action@v2
 with:
Expand Down

7 changes: 2 additions & 5 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down

1 change: 0 additions & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down

19 changes: 4 additions & 15 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
	if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
 b
	}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
	min_u64(FRESHNESS_TIMER, PING_TIMER),
	min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
	} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
	use core::future::Future;
	use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
 unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
	}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
	feature = "std",
	doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = "	handle.await.unwrap()")]
///	# }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
	'a,
	UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_channel_manager_persist_error_async() {
 // Test that if we encounter an error during manager persistence, the thread panics.
 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_payment_path_scoring_async() {
 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
 let event_handler = move |event: Event| {
Expand Down

2 changes: 1 addition & 1 deletion
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }

2 changes: 1 addition & 1 deletion
no-std-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }

, '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('^' + ".*" + '
Drop background processor futures feature by joostjager · Pull Request #3777 · lightningdevkit/rust-lightning · GitHub
Skip to content
Drop background processor futures feature#3777

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

TheBlueMatt
merged 1 commit into

from

May 14, 2025
 Merged


Drop background processor futures feature
#3777
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


6 changes: 3 additions & 3 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
 run: |
 cargo install cargo-llvm-cov
 export RUSTFLAGS="-Coverflow-checks=off"
 cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
 cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
 # Could you use this to fake the coverage report for your PR? Sure.
 # Will anyone be impressed by your amazing coverage? No
 # Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
 - name: Run cargo check for release build.
 run: |
 cargo check --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 - name: Run cargo check for Taproot build.
 run: |
 cargo check --release
 cargo check --no-default-features --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 cargo doc --no-default-features --release
 env:
Expand Down

1 change: 0 additions & 1 deletion
.github/workflows/semver.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
 with:
 package: lightning-background-processor
 feature-group: only-explicit-features
 features: futures
 - name: Check lightning-block-sync SemVer
 uses: obi1kenobi/cargo-semver-checks-action@v2
 with:
Expand Down

7 changes: 2 additions & 5 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down

1 change: 0 additions & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down

19 changes: 4 additions & 15 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
	if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
 b
	}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
	min_u64(FRESHNESS_TIMER, PING_TIMER),
	min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
	} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
	use core::future::Future;
	use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
 unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
	}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
	feature = "std",
	doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = "	handle.await.unwrap()")]
///	# }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
	'a,
	UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_channel_manager_persist_error_async() {
 // Test that if we encounter an error during manager persistence, the thread panics.
 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_payment_path_scoring_async() {
 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
 let event_handler = move |event: Event| {
Expand Down

2 changes: 1 addition & 1 deletion
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }

2 changes: 1 addition & 1 deletion
no-std-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }

, '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('^' + ".*" + '
Drop background processor futures feature by joostjager · Pull Request #3777 · lightningdevkit/rust-lightning · GitHub
Skip to content
Drop background processor futures feature#3777

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

TheBlueMatt
merged 1 commit into

from

May 14, 2025
 Merged


Drop background processor futures feature
#3777
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


6 changes: 3 additions & 3 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
 run: |
 cargo install cargo-llvm-cov
 export RUSTFLAGS="-Coverflow-checks=off"
 cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
 cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
 # Could you use this to fake the coverage report for your PR? Sure.
 # Will anyone be impressed by your amazing coverage? No
 # Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
 - name: Run cargo check for release build.
 run: |
 cargo check --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 - name: Run cargo check for Taproot build.
 run: |
 cargo check --release
 cargo check --no-default-features --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 cargo doc --no-default-features --release
 env:
Expand Down

1 change: 0 additions & 1 deletion
.github/workflows/semver.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
 with:
 package: lightning-background-processor
 feature-group: only-explicit-features
 features: futures
 - name: Check lightning-block-sync SemVer
 uses: obi1kenobi/cargo-semver-checks-action@v2
 with:
Expand Down

7 changes: 2 additions & 5 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down

1 change: 0 additions & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down

19 changes: 4 additions & 15 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
	if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
 b
	}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
	min_u64(FRESHNESS_TIMER, PING_TIMER),
	min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
	} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
	use core::future::Future;
	use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
 unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
	}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
	feature = "std",
	doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = "	handle.await.unwrap()")]
///	# }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
	'a,
	UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_channel_manager_persist_error_async() {
 // Test that if we encounter an error during manager persistence, the thread panics.
 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_payment_path_scoring_async() {
 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
 let event_handler = move |event: Event| {
Expand Down

2 changes: 1 addition & 1 deletion
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }

2 changes: 1 addition & 1 deletion
no-std-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }

, '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); }
})();
})();
Drop background processor futures feature by joostjager · Pull Request #3777 · lightningdevkit/rust-lightning · GitHub
Skip to content
Drop background processor futures feature#3777

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

TheBlueMatt
merged 1 commit into

from

May 14, 2025
 Merged


Drop background processor futures feature
#3777
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


6 changes: 3 additions & 3 deletions
.github/workflows/build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,7 +122,7 @@ jobs:
 run: |
 cargo install cargo-llvm-cov
 export RUSTFLAGS="-Coverflow-checks=off"
 cargo llvm-cov --features rest-client,rpc-client,tokio,futures,serde --codecov --hide-instantiations --output-path=target/codecov.json
 cargo llvm-cov --features rest-client,rpc-client,tokio,serde --codecov --hide-instantiations --output-path=target/codecov.json
 # Could you use this to fake the coverage report for your PR? Sure.
 # Will anyone be impressed by your amazing coverage? No
 # Maybe if codecov wasn't broken we wouldn't need to do this...
Expand DownExpand Up@@ -232,13 +232,13 @@ jobs:
 - name: Run cargo check for release build.
 run: |
 cargo check --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 - name: Run cargo check for Taproot build.
 run: |
 cargo check --release
 cargo check --no-default-features --release
 cargo check --no-default-features --features=futures,std --release
 cargo check --no-default-features --features=std --release
 cargo doc --release
 cargo doc --no-default-features --release
 env:
Expand Down

1 change: 0 additions & 1 deletion
.github/workflows/semver.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,6 @@ jobs:
 with:
 package: lightning-background-processor
 feature-group: only-explicit-features
 features: futures
 - name: Check lightning-block-sync SemVer
 uses: obi1kenobi/cargo-semver-checks-action@v2
 with:
Expand Down

7 changes: 2 additions & 5 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,10 +68,6 @@ cargo check -p lightning-block-sync --verbose --color always --features rpc-clie
cargo test -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio
cargo check -p lightning-block-sync --verbose --color always --features rpc-client,rest-client,tokio

echo -e "\n\nTest futures builds"
cargo test -p lightning-background-processor --verbose --color always --features futures
cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features

echo -e "\n\nTest Custom Message Macros"
cargo test -p lightning-custom-message --verbose --color always
[ "$CI_MINIMIZE_DISK_USAGE" != "" ] && cargo clean
Expand All@@ -85,6 +81,7 @@ for DIR in lightning-invoice lightning-rapid-gossip-sync lightning-liquidity; do
done

cargo test -p lightning --verbose --color always --no-default-features
cargo test -p lightning-background-processor --verbose --color always --no-default-features

echo -e "\n\nTesting c_bindings builds"
# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
Expand All@@ -98,7 +95,7 @@ done

# Note that because `$RUSTFLAGS` is not passed through to doctest builds we cannot selectively
# disable doctests in `c_bindings` so we skip doctests entirely here.
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --features futures --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning-background-processor --verbose --color always --no-default-features --lib --bins --tests
RUSTFLAGS="$RUSTFLAGS --cfg=c_bindings" cargo test -p lightning --verbose --color always --no-default-features --lib --bins --tests

echo -e "\n\nTesting other crate-specific builds"
Expand Down

1 change: 0 additions & 1 deletion
lightning-background-processor/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,6 @@ all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
futures = [ ]
std = ["lightning/std", "lightning-liquidity/std", "bitcoin-io/std", "bitcoin_hashes/std"]

default = ["std"]
Expand Down

19 changes: 4 additions & 15 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(missing_docs)]
#![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]

Expand All@@ -25,7 +24,6 @@ use lightning::chain::chainmonitor::{ChainMonitor, Persist};
use lightning::events::EventHandler;
#[cfg(feature = "std")]
use lightning::events::EventsProvider;
#[cfg(feature = "futures")]
use lightning::events::ReplayEvent;
use lightning::events::{Event, PathFailure};

Expand All@@ -36,14 +34,12 @@ use lightning::onion_message::messenger::AOnionMessenger;
use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::scoring::{ScoreUpdate, WriteableScore};
use lightning::routing::utxo::UtxoLookup;
#[cfg(feature = "futures")]
use lightning::sign::ChangeDestinationSource;
#[cfg(feature = "std")]
use lightning::sign::ChangeDestinationSourceSync;
use lightning::sign::OutputSpender;
use lightning::util::logger::Logger;
use lightning::util::persist::{KVStore, Persister};
#[cfg(feature = "futures")]
use lightning::util::sweep::OutputSweeper;
#[cfg(feature = "std")]
use lightning::util::sweep::OutputSweeperSync;
Expand DownExpand Up@@ -146,7 +142,6 @@ const SWEEPER_TIMER: u64 = 30;
#[cfg(test)]
const SWEEPER_TIMER: u64 = 1;

#[cfg(feature = "futures")]
/// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
const fn min_u64(a: u64, b: u64) -> u64 {
	if a < b {
Expand All@@ -155,7 +150,6 @@ const fn min_u64(a: u64, b: u64) -> u64 {
 b
	}
}
#[cfg(feature = "futures")]
const FASTEST_TIMER: u64 = min_u64(
	min_u64(FRESHNESS_TIMER, PING_TIMER),
	min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)),
Expand DownExpand Up@@ -508,7 +502,6 @@ macro_rules! define_run_body {
	} }
}

#[cfg(feature = "futures")]
pub(crate) mod futures_util {
	use core::future::Future;
	use core::marker::Unpin;
Expand DownExpand Up@@ -622,9 +615,7 @@ pub(crate) mod futures_util {
 unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) }
	}
}
#[cfg(feature = "futures")]
use core::task;
#[cfg(feature = "futures")]
use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};

/// Processes background events in a future.
Expand All@@ -634,8 +625,10 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
/// future which outputs `true`, the loop will exit and this function's future will complete.
/// The `sleeper` future is free to return early after it has triggered the exit condition.
///
/// See [`BackgroundProcessor::start`] for information on which actions this handles.
///
#[cfg_attr(
	feature = "std",
	doc = " See [`BackgroundProcessor::start`] for information on which actions this handles.\n"
)]
/// The `mobile_interruptable_platform` flag should be set if we're currently running on a
/// mobile device, where we may need to check for interruption of the application regularly. If you
/// are unsure, you should set the flag, as the performance impact of it is minimal unless there
Expand DownExpand Up@@ -775,7 +768,6 @@ use futures_util::{dummy_waker, OptionalSelector, Selector, SelectorOutput};
#[cfg_attr(feature = "std", doc = "	handle.await.unwrap()")]
///	# }
///```
#[cfg(feature = "futures")]
pub async fn process_events_async<
	'a,
	UL: 'static + Deref,
Expand DownExpand Up@@ -2096,7 +2088,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_channel_manager_persist_error_async() {
 // Test that if we encounter an error during manager persistence, the thread panics.
 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
Expand DownExpand Up@@ -2605,7 +2596,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
 let (sender, receiver) = std::sync::mpsc::sync_channel(1);

Expand DownExpand Up@@ -2808,7 +2798,6 @@ mod tests {
	}

	#[tokio::test]
	#[cfg(feature = "futures")]
	async fn test_payment_path_scoring_async() {
 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
 let event_handler = move |event: Event| {
Expand Down

2 changes: 1 addition & 1 deletion
msrv-no-dev-deps-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,6 @@ lightning-block-sync = { path = "../lightning-block-sync", features = [ "rest-cl
lightning-invoice = { path = "../lightning-invoice" }
lightning-net-tokio = { path = "../lightning-net-tokio" }
lightning-persister = { path = "../lightning-persister" }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"] }
lightning-background-processor = { path = "../lightning-background-processor" }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" }
lightning-custom-message = { path = "../lightning-custom-message" }

2 changes: 1 addition & 1 deletion
no-std-check/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,4 +10,4 @@ default = []
lightning = { path = "../lightning", default-features = false }
lightning-invoice = { path = "../lightning-invoice", default-features = false }
lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync", default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", features = ["futures"], default-features = false }
lightning-background-processor = { path = "../lightning-background-processor", default-features = false }