Skip to content

Clean up persistence constants#4105

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
TheBlueMatt wants to merge 4 commits into from
Closed

Clean up persistence constants #4105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c08ea1d
Rename namespace validity constants to be more concise
TheBlueMatt Sep 22, 2025
1660c72
Rename persistence namespace/key constants to be more concise
TheBlueMatt Sep 22, 2025
98e6a8e
Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""
TheBlueMatt Sep 22, 2025
5ffee02
Remove unnecessary variable indirection in `persist.rs`
TheBlueMatt Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 44 additions & 92 deletions lightning-background-processor/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
if let Some(duration_since_epoch) = fetch_time() {
if update_scorer(scorer, &event, duration_since_epoch) {
log_trace!(logger, "Persisting scorer after update");
if let Err(e) = kv_store
.write(
SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY,
scorer.encode(),
)
.await
if let Err(e) =
kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
{
log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
// We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
let fut = async {

@valentinewallacevalentinewallaceNov 14, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here and below, we could do:

diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);

kv_store
.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
channel_manager.get_cm().encode(),
)
.await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
let fut = async {
if let Err(e) = kv_store
.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
network_graph.encode(),
)
.await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
log_trace!(logger, "Persisting scorer");
}
let fut = async {
if let Err(e) = kv_store
.write(
SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY,
scorer.encode(),
)
.await
if let Err(e) =
kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
{
log_error!(
logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
kv_store
.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
channel_manager.get_cm().encode(),
)
.await?;
if let Some(ref scorer) = scorer {
kv_store
.write(
SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY,
scorer.encode(),
)
.await?;
kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
}
if let Some(network_graph) = gossip_sync.network_graph() {
kv_store
.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
network_graph.encode(),
)
.write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
.await?;
}
Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
.expect("Time should be sometime after 1970");
if update_scorer(scorer, &event, duration_since_epoch) {
log_trace!(logger, "Persisting scorer after update");
if let Err(e) = kv_store.write(
SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY,
scorer.encode(),
) {
if let Err(e) =
kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
{
log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
}
}
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
(kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
channel_manager.get_cm().encode(),
))?;
log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
duration_since_epoch.as_secs(),
);
if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
network_graph.encode(),
) {
log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
.expect("Time should be sometime after 1970");
log_trace!(logger, "Calling time_passed and persisting scorer");
scorer.write_lock().time_passed(duration_since_epoch);
if let Err(e) = kv_store.write(
SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY,
scorer.encode(),
) {
if let Err(e) =
kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
{
log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
}
}
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
// some races where users quit while channel updates were in-flight, with
// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
channel_manager.get_cm().encode(),
)?;
if let Some(ref scorer) = scorer {
kv_store.write(
SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY,
scorer.encode(),
)?;
kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
}
if let Some(network_graph) = gossip_sync.network_graph() {
kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
network_graph.encode(),
)?;
}
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
use lightning::types::payment::PaymentHash;
use lightning::util::config::UserConfig;
use lightning::util::persist::{
KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::ser::Writeable;
use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
fn write(
&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
) -> lightning::io::Result<()> {
if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
&& secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
&& key == CHANNEL_MANAGER_PERSISTENCE_KEY
{
if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
assert_eq!(secondary_namespace, "");
if let Some((error, message)) = self.manager_error {
return Err(std::io::Error::new(error, message).into());
}
}

if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
&& secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
&& key == NETWORK_GRAPH_PERSISTENCE_KEY
{
if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
assert_eq!(secondary_namespace, "");
if let Some(sender) = &self.graph_persistence_notifier {
match sender.send(()) {
Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
}
}

if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
&& secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
&& key == SCORER_PERSISTENCE_KEY
{
if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
assert_eq!(secondary_namespace, "");
if let Some((error, message)) = self.scorer_error {
return Err(std::io::Error::new(error, message).into());
}
Expand Down
13 changes: 6 additions & 7 deletions lightning-persister/src/test_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
assert_eq!(listed_keys.len(), 0);

// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
// KVSTORE_NAMESPACE_KEY_MAX_LEN
let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
// NAMESPACE_MAX_LEN
let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
let primary_namespace = if i == 0 {
String::new()
} else {
format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
};
for j in 0..num_secondary_namespaces {
let secondary_namespace = if i == 0 || j == 0 {
String::new()
} else {
format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
};
for k in 0..num_keys {
let key =
format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
source_store
.write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
.unwrap();
Expand Down
5 changes: 2 additions & 3 deletions lightning-persister/src/utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
&& key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

TheBlueMatt
wants to merge
4
commits into

from

 Closed


Clean up persistence constants
#4105
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c08ea1d

Rename namespace validity constants to be more concise


TheBlueMatt Sep 22, 2025
1660c72

Rename persistence namespace/key constants to be more concise


TheBlueMatt Sep 22, 2025
98e6a8e

Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""


TheBlueMatt Sep 22, 2025
5ffee02

Remove unnecessary variable indirection in `persist.rs`


TheBlueMatt Sep 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


136 changes: 44 additions & 92 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
	NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
 if let Some(duration_since_epoch) = fetch_time() {
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 // We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
 let fut = async {
@valentinewallacevalentinewallaceNov 14, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Here and below, we could do:
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);
 kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
 let fut = async {
 if let Err(e) = kv_store
 .write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )
 .await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
 log_trace!(logger, "Persisting scorer");
 }
 let fut = async {
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(
 logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	if let Some(ref scorer) = scorer {
 kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
	}
	if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store
 .write(
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_KEY,
 network_graph.encode(),
 )
 .write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
 .await?;
	}
	Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 }
 }
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
 duration_since_epoch.as_secs(),
 );
 if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 ) {
 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 log_trace!(logger, "Calling time_passed and persisting scorer");
 scorer.write_lock().time_passed(duration_since_epoch);
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 }
 }
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )?;
 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
 }
 if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )?;
 }
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
	use lightning::types::payment::PaymentHash;
	use lightning::util::config::UserConfig;
	use lightning::util::persist::{
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
 NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
	};
	use lightning::util::ser::Writeable;
	use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
 fn write(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
 ) -> lightning::io::Result<()> {
 if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == CHANNEL_MANAGER_PERSISTENCE_KEY
 {
 if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message).into());
 }
 }

 if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
 && key == NETWORK_GRAPH_PERSISTENCE_KEY
 {
 if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some(sender) = &self.graph_persistence_notifier {
 match sender.send(()) {
 Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
 }
 }

 if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == SCORER_PERSISTENCE_KEY
 {
 if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.scorer_error {
 return Err(std::io::Error::new(error, message).into());
 }
Expand Down

13 changes: 6 additions & 7 deletions
lightning-persister/src/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
	assert_eq!(listed_keys.len(), 0);

	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
	// KVSTORE_NAMESPACE_KEY_MAX_LEN
	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
	// NAMESPACE_MAX_LEN
	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 let primary_namespace = if i == 0 {
 String::new()
 } else {
 format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
 format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 };
 for j in 0..num_secondary_namespaces {
 let secondary_namespace = if i == 0 || j == 0 {
 String::new()
 } else {
 format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
 format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 };
 for k in 0..num_keys {
 let key =
 format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
 let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 source_store
 .write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 .unwrap();
Expand Down

5 changes: 2 additions & 3 deletions
lightning-persister/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
 && key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

pub(crate) fn check_namespace_key_validity(
Expand Down
Loading
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

TheBlueMatt
wants to merge
4
commits into

from

 Closed


Clean up persistence constants
#4105
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c08ea1d

Rename namespace validity constants to be more concise


TheBlueMatt Sep 22, 2025
1660c72

Rename persistence namespace/key constants to be more concise


TheBlueMatt Sep 22, 2025
98e6a8e

Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""


TheBlueMatt Sep 22, 2025
5ffee02

Remove unnecessary variable indirection in `persist.rs`


TheBlueMatt Sep 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


136 changes: 44 additions & 92 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
	NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
 if let Some(duration_since_epoch) = fetch_time() {
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 // We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
 let fut = async {
@valentinewallacevalentinewallaceNov 14, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Here and below, we could do:
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);
 kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
 let fut = async {
 if let Err(e) = kv_store
 .write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )
 .await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
 log_trace!(logger, "Persisting scorer");
 }
 let fut = async {
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(
 logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	if let Some(ref scorer) = scorer {
 kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
	}
	if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store
 .write(
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_KEY,
 network_graph.encode(),
 )
 .write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
 .await?;
	}
	Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 }
 }
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
 duration_since_epoch.as_secs(),
 );
 if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 ) {
 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 log_trace!(logger, "Calling time_passed and persisting scorer");
 scorer.write_lock().time_passed(duration_since_epoch);
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 }
 }
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )?;
 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
 }
 if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )?;
 }
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
	use lightning::types::payment::PaymentHash;
	use lightning::util::config::UserConfig;
	use lightning::util::persist::{
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
 NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
	};
	use lightning::util::ser::Writeable;
	use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
 fn write(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
 ) -> lightning::io::Result<()> {
 if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == CHANNEL_MANAGER_PERSISTENCE_KEY
 {
 if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message).into());
 }
 }

 if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
 && key == NETWORK_GRAPH_PERSISTENCE_KEY
 {
 if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some(sender) = &self.graph_persistence_notifier {
 match sender.send(()) {
 Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
 }
 }

 if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == SCORER_PERSISTENCE_KEY
 {
 if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.scorer_error {
 return Err(std::io::Error::new(error, message).into());
 }
Expand Down

13 changes: 6 additions & 7 deletions
lightning-persister/src/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
	assert_eq!(listed_keys.len(), 0);

	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
	// KVSTORE_NAMESPACE_KEY_MAX_LEN
	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
	// NAMESPACE_MAX_LEN
	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 let primary_namespace = if i == 0 {
 String::new()
 } else {
 format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
 format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 };
 for j in 0..num_secondary_namespaces {
 let secondary_namespace = if i == 0 || j == 0 {
 String::new()
 } else {
 format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
 format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 };
 for k in 0..num_keys {
 let key =
 format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
 let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 source_store
 .write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 .unwrap();
Expand Down

5 changes: 2 additions & 3 deletions
lightning-persister/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
 && key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

pub(crate) fn check_namespace_key_validity(
Expand Down
Loading
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

TheBlueMatt
wants to merge
4
commits into

from

 Closed


Clean up persistence constants
#4105
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c08ea1d

Rename namespace validity constants to be more concise


TheBlueMatt Sep 22, 2025
1660c72

Rename persistence namespace/key constants to be more concise


TheBlueMatt Sep 22, 2025
98e6a8e

Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""


TheBlueMatt Sep 22, 2025
5ffee02

Remove unnecessary variable indirection in `persist.rs`


TheBlueMatt Sep 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


136 changes: 44 additions & 92 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
	NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
 if let Some(duration_since_epoch) = fetch_time() {
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 // We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
 let fut = async {
@valentinewallacevalentinewallaceNov 14, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Here and below, we could do:
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);
 kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
 let fut = async {
 if let Err(e) = kv_store
 .write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )
 .await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
 log_trace!(logger, "Persisting scorer");
 }
 let fut = async {
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(
 logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	if let Some(ref scorer) = scorer {
 kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
	}
	if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store
 .write(
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_KEY,
 network_graph.encode(),
 )
 .write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
 .await?;
	}
	Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 }
 }
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
 duration_since_epoch.as_secs(),
 );
 if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 ) {
 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 log_trace!(logger, "Calling time_passed and persisting scorer");
 scorer.write_lock().time_passed(duration_since_epoch);
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 }
 }
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )?;
 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
 }
 if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )?;
 }
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
	use lightning::types::payment::PaymentHash;
	use lightning::util::config::UserConfig;
	use lightning::util::persist::{
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
 NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
	};
	use lightning::util::ser::Writeable;
	use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
 fn write(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
 ) -> lightning::io::Result<()> {
 if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == CHANNEL_MANAGER_PERSISTENCE_KEY
 {
 if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message).into());
 }
 }

 if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
 && key == NETWORK_GRAPH_PERSISTENCE_KEY
 {
 if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some(sender) = &self.graph_persistence_notifier {
 match sender.send(()) {
 Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
 }
 }

 if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == SCORER_PERSISTENCE_KEY
 {
 if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.scorer_error {
 return Err(std::io::Error::new(error, message).into());
 }
Expand Down

13 changes: 6 additions & 7 deletions
lightning-persister/src/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
	assert_eq!(listed_keys.len(), 0);

	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
	// KVSTORE_NAMESPACE_KEY_MAX_LEN
	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
	// NAMESPACE_MAX_LEN
	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 let primary_namespace = if i == 0 {
 String::new()
 } else {
 format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
 format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 };
 for j in 0..num_secondary_namespaces {
 let secondary_namespace = if i == 0 || j == 0 {
 String::new()
 } else {
 format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
 format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 };
 for k in 0..num_keys {
 let key =
 format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
 let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 source_store
 .write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 .unwrap();
Expand Down

5 changes: 2 additions & 3 deletions
lightning-persister/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
 && key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

pub(crate) fn check_namespace_key_validity(
Expand Down
Loading
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

TheBlueMatt
wants to merge
4
commits into

from

 Closed


Clean up persistence constants
#4105
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c08ea1d

Rename namespace validity constants to be more concise


TheBlueMatt Sep 22, 2025
1660c72

Rename persistence namespace/key constants to be more concise


TheBlueMatt Sep 22, 2025
98e6a8e

Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""


TheBlueMatt Sep 22, 2025
5ffee02

Remove unnecessary variable indirection in `persist.rs`


TheBlueMatt Sep 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


136 changes: 44 additions & 92 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
	NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
 if let Some(duration_since_epoch) = fetch_time() {
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 // We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
 let fut = async {
@valentinewallacevalentinewallaceNov 14, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Here and below, we could do:
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);
 kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
 let fut = async {
 if let Err(e) = kv_store
 .write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )
 .await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
 log_trace!(logger, "Persisting scorer");
 }
 let fut = async {
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(
 logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	if let Some(ref scorer) = scorer {
 kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
	}
	if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store
 .write(
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_KEY,
 network_graph.encode(),
 )
 .write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
 .await?;
	}
	Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 }
 }
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
 duration_since_epoch.as_secs(),
 );
 if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 ) {
 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 log_trace!(logger, "Calling time_passed and persisting scorer");
 scorer.write_lock().time_passed(duration_since_epoch);
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 }
 }
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )?;
 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
 }
 if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )?;
 }
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
	use lightning::types::payment::PaymentHash;
	use lightning::util::config::UserConfig;
	use lightning::util::persist::{
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
 NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
	};
	use lightning::util::ser::Writeable;
	use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
 fn write(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
 ) -> lightning::io::Result<()> {
 if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == CHANNEL_MANAGER_PERSISTENCE_KEY
 {
 if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message).into());
 }
 }

 if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
 && key == NETWORK_GRAPH_PERSISTENCE_KEY
 {
 if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some(sender) = &self.graph_persistence_notifier {
 match sender.send(()) {
 Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
 }
 }

 if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == SCORER_PERSISTENCE_KEY
 {
 if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.scorer_error {
 return Err(std::io::Error::new(error, message).into());
 }
Expand Down

13 changes: 6 additions & 7 deletions
lightning-persister/src/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
	assert_eq!(listed_keys.len(), 0);

	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
	// KVSTORE_NAMESPACE_KEY_MAX_LEN
	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
	// NAMESPACE_MAX_LEN
	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 let primary_namespace = if i == 0 {
 String::new()
 } else {
 format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
 format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 };
 for j in 0..num_secondary_namespaces {
 let secondary_namespace = if i == 0 || j == 0 {
 String::new()
 } else {
 format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
 format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 };
 for k in 0..num_keys {
 let key =
 format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
 let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 source_store
 .write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 .unwrap();
Expand Down

5 changes: 2 additions & 3 deletions
lightning-persister/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
 && key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

pub(crate) fn check_namespace_key_validity(
Expand Down
Loading
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

TheBlueMatt
wants to merge
4
commits into

from

 Closed


Clean up persistence constants
#4105
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c08ea1d

Rename namespace validity constants to be more concise


TheBlueMatt Sep 22, 2025
1660c72

Rename persistence namespace/key constants to be more concise


TheBlueMatt Sep 22, 2025
98e6a8e

Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""


TheBlueMatt Sep 22, 2025
5ffee02

Remove unnecessary variable indirection in `persist.rs`


TheBlueMatt Sep 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


136 changes: 44 additions & 92 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
	NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
 if let Some(duration_since_epoch) = fetch_time() {
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 // We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
 let fut = async {
@valentinewallacevalentinewallaceNov 14, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Here and below, we could do:
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);
 kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
 let fut = async {
 if let Err(e) = kv_store
 .write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )
 .await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
 log_trace!(logger, "Persisting scorer");
 }
 let fut = async {
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(
 logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	if let Some(ref scorer) = scorer {
 kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
	}
	if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store
 .write(
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_KEY,
 network_graph.encode(),
 )
 .write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
 .await?;
	}
	Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 }
 }
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
 duration_since_epoch.as_secs(),
 );
 if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 ) {
 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 log_trace!(logger, "Calling time_passed and persisting scorer");
 scorer.write_lock().time_passed(duration_since_epoch);
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 }
 }
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )?;
 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
 }
 if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )?;
 }
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
	use lightning::types::payment::PaymentHash;
	use lightning::util::config::UserConfig;
	use lightning::util::persist::{
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
 NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
	};
	use lightning::util::ser::Writeable;
	use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
 fn write(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
 ) -> lightning::io::Result<()> {
 if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == CHANNEL_MANAGER_PERSISTENCE_KEY
 {
 if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message).into());
 }
 }

 if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
 && key == NETWORK_GRAPH_PERSISTENCE_KEY
 {
 if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some(sender) = &self.graph_persistence_notifier {
 match sender.send(()) {
 Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
 }
 }

 if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == SCORER_PERSISTENCE_KEY
 {
 if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.scorer_error {
 return Err(std::io::Error::new(error, message).into());
 }
Expand Down

13 changes: 6 additions & 7 deletions
lightning-persister/src/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
	assert_eq!(listed_keys.len(), 0);

	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
	// KVSTORE_NAMESPACE_KEY_MAX_LEN
	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
	// NAMESPACE_MAX_LEN
	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 let primary_namespace = if i == 0 {
 String::new()
 } else {
 format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
 format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 };
 for j in 0..num_secondary_namespaces {
 let secondary_namespace = if i == 0 || j == 0 {
 String::new()
 } else {
 format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
 format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 };
 for k in 0..num_keys {
 let key =
 format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
 let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 source_store
 .write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 .unwrap();
Expand Down

5 changes: 2 additions & 3 deletions
lightning-persister/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
 && key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

pub(crate) fn check_namespace_key_validity(
Expand Down
Loading
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

TheBlueMatt
wants to merge
4
commits into

from

 Closed


Clean up persistence constants
#4105
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c08ea1d

Rename namespace validity constants to be more concise


TheBlueMatt Sep 22, 2025
1660c72

Rename persistence namespace/key constants to be more concise


TheBlueMatt Sep 22, 2025
98e6a8e

Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""


TheBlueMatt Sep 22, 2025
5ffee02

Remove unnecessary variable indirection in `persist.rs`


TheBlueMatt Sep 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


136 changes: 44 additions & 92 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
	NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
 if let Some(duration_since_epoch) = fetch_time() {
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 // We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
 let fut = async {
@valentinewallacevalentinewallaceNov 14, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Here and below, we could do:
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);
 kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
 let fut = async {
 if let Err(e) = kv_store
 .write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )
 .await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
 log_trace!(logger, "Persisting scorer");
 }
 let fut = async {
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(
 logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	if let Some(ref scorer) = scorer {
 kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
	}
	if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store
 .write(
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_KEY,
 network_graph.encode(),
 )
 .write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
 .await?;
	}
	Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 }
 }
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
 duration_since_epoch.as_secs(),
 );
 if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 ) {
 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 log_trace!(logger, "Calling time_passed and persisting scorer");
 scorer.write_lock().time_passed(duration_since_epoch);
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 }
 }
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )?;
 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
 }
 if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )?;
 }
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
	use lightning::types::payment::PaymentHash;
	use lightning::util::config::UserConfig;
	use lightning::util::persist::{
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
 NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
	};
	use lightning::util::ser::Writeable;
	use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
 fn write(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
 ) -> lightning::io::Result<()> {
 if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == CHANNEL_MANAGER_PERSISTENCE_KEY
 {
 if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message).into());
 }
 }

 if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
 && key == NETWORK_GRAPH_PERSISTENCE_KEY
 {
 if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some(sender) = &self.graph_persistence_notifier {
 match sender.send(()) {
 Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
 }
 }

 if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == SCORER_PERSISTENCE_KEY
 {
 if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.scorer_error {
 return Err(std::io::Error::new(error, message).into());
 }
Expand Down

13 changes: 6 additions & 7 deletions
lightning-persister/src/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
	assert_eq!(listed_keys.len(), 0);

	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
	// KVSTORE_NAMESPACE_KEY_MAX_LEN
	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
	// NAMESPACE_MAX_LEN
	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 let primary_namespace = if i == 0 {
 String::new()
 } else {
 format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
 format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 };
 for j in 0..num_secondary_namespaces {
 let secondary_namespace = if i == 0 || j == 0 {
 String::new()
 } else {
 format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
 format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 };
 for k in 0..num_keys {
 let key =
 format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
 let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 source_store
 .write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 .unwrap();
Expand Down

5 changes: 2 additions & 3 deletions
lightning-persister/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
 && key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

pub(crate) fn check_namespace_key_validity(
Expand Down
Loading
Loading

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

TheBlueMatt
wants to merge
4
commits into

from

 Closed


Clean up persistence constants
#4105
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c08ea1d

Rename namespace validity constants to be more concise


TheBlueMatt Sep 22, 2025
1660c72

Rename persistence namespace/key constants to be more concise


TheBlueMatt Sep 22, 2025
98e6a8e

Drop verbose `*_SECONDARY_NAMESPACE` consts that are always ""


TheBlueMatt Sep 22, 2025
5ffee02

Remove unnecessary variable indirection in `persist.rs`


TheBlueMatt Sep 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


136 changes: 44 additions & 92 deletions
lightning-background-processor/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,11 +53,8 @@ use lightning::sign::{
};
use lightning::util::logger::Logger;
use lightning::util::persist::{
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
	CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_KEY, NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
	NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE, SCORER_PERSISTENCE_KEY,
	SCORER_PERSISTENCE_PRIMARY_NAMESPACE, SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
	KVStore, KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
	NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
};
use lightning::util::sweep::{OutputSweeper, OutputSweeperSync};
#[cfg(feature = "std")]
Expand DownExpand Up@@ -942,14 +939,8 @@ where
 if let Some(duration_since_epoch) = fetch_time() {
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 // We opt not to abort early on persistence failure here as persisting
Expand DownExpand Up@@ -1080,9 +1071,9 @@ where
 let fut = async {
@valentinewallacevalentinewallaceNov 14, 2025

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Here and below, we could do:
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
index 7b4f29896..af851f5f6 100644
--- a/lightning-background-processor/src/lib.rs+++ b/lightning-background-processor/src/lib.rs@@ -1068,15 +1068,9 @@ where
if channel_manager.get_cm().get_and_clear_needs_persistence() {
log_trace!(logger, "Persisting ChannelManager...");
+ let mgr = channel_manager.get_cm().encode();
let fut = async {
- kv_store- .write(- CHANNEL_MANAGER_NAMESPACE,- "",- CHANNEL_MANAGER_KEY,- channel_manager.get_cm().encode(),- )- .await+ kv_store.write(CHANNEL_MANAGER_NAMESPACE, "", CHANNEL_MANAGER_KEY, mgr).await
};
// TODO: Once our MSRV is 1.68 we should be able to drop the Box
let mut fut = Box::pin(fut);
 kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await
Expand DownExpand Up@@ -1143,9 +1134,9 @@ where
 let fut = async {
 if let Err(e) = kv_store
 .write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )
 .await
Expand DownExpand Up@@ -1183,14 +1174,8 @@ where
 log_trace!(logger, "Persisting scorer");
 }
 let fut = async {
 if let Err(e) = kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await
 {
 log_error!(
 logger,
Expand DownExpand Up@@ -1301,30 +1286,18 @@ where
	// ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
	kv_store
 .write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )
 .await?;
	if let Some(ref scorer) = scorer {
 kv_store
 .write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )
 .await?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode()).await?;
	}
	if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store
 .write(
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 NETWORK_GRAPH_PERSISTENCE_KEY,
 network_graph.encode(),
 )
 .write(NETWORK_GRAPH_NAMESPACE, "", NETWORK_GRAPH_KEY, network_graph.encode())
 .await?;
	}
	Ok(())
Expand DownExpand Up@@ -1526,12 +1499,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 if update_scorer(scorer, &event, duration_since_epoch) {
 log_trace!(logger, "Persisting scorer after update");
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 }
 }
Expand DownExpand Up@@ -1627,9 +1597,9 @@ impl BackgroundProcessor {
 if channel_manager.get_cm().get_and_clear_needs_persistence() {
 log_trace!(logger, "Persisting ChannelManager...");
 (kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 ))?;
 log_trace!(logger, "Done persisting ChannelManager.");
Expand DownExpand Up@@ -1666,9 +1636,9 @@ impl BackgroundProcessor {
 duration_since_epoch.as_secs(),
 );
 if let Err(e) = kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 ) {
 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e);
Expand All@@ -1694,12 +1664,9 @@ impl BackgroundProcessor {
 .expect("Time should be sometime after 1970");
 log_trace!(logger, "Calling time_passed and persisting scorer");
 scorer.write_lock().time_passed(duration_since_epoch);
 if let Err(e) = kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 ) {
 if let Err(e) =
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())
 {
 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e);
 }
 }
Expand DownExpand Up@@ -1735,24 +1702,19 @@ impl BackgroundProcessor {
 // some races where users quit while channel updates were in-flight, with
 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 kv_store.write(
CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
CHANNEL_MANAGER_PERSISTENCE_KEY,
CHANNEL_MANAGER_NAMESPACE,
"",
CHANNEL_MANAGER_KEY,
 channel_manager.get_cm().encode(),
 )?;
 if let Some(ref scorer) = scorer {
 kv_store.write(
 SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY,
 scorer.encode(),
 )?;
 kv_store.write(SCORER_NAMESPACE, "", SCORER_KEY, scorer.encode())?;
 }
 if let Some(network_graph) = gossip_sync.network_graph() {
 kv_store.write(
NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
NETWORK_GRAPH_PERSISTENCE_KEY,
NETWORK_GRAPH_NAMESPACE,
"",
NETWORK_GRAPH_KEY,
 network_graph.encode(),
 )?;
 }
Expand DownExpand Up@@ -1844,12 +1806,8 @@ mod tests {
	use lightning::types::payment::PaymentHash;
	use lightning::util::config::UserConfig;
	use lightning::util::persist::{
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_PERSISTENCE_KEY,
 CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_KEY,
 NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE, NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
 SCORER_PERSISTENCE_KEY, SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
 KVStoreSync, KVStoreSyncWrapper, CHANNEL_MANAGER_KEY, CHANNEL_MANAGER_NAMESPACE,
 NETWORK_GRAPH_KEY, NETWORK_GRAPH_NAMESPACE, SCORER_KEY, SCORER_NAMESPACE,
	};
	use lightning::util::ser::Writeable;
	use lightning::util::sweep::{
Expand DownExpand Up@@ -2104,19 +2062,15 @@ mod tests {
 fn write(
 &self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: Vec<u8>,
 ) -> lightning::io::Result<()> {
 if primary_namespace == CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == CHANNEL_MANAGER_PERSISTENCE_KEY
 {
 if primary_namespace == CHANNEL_MANAGER_NAMESPACE && key == CHANNEL_MANAGER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.manager_error {
 return Err(std::io::Error::new(error, message).into());
 }
 }

 if primary_namespace == NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE
 && key == NETWORK_GRAPH_PERSISTENCE_KEY
 {
 if primary_namespace == NETWORK_GRAPH_NAMESPACE && key == NETWORK_GRAPH_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some(sender) = &self.graph_persistence_notifier {
 match sender.send(()) {
 Ok(()) => {},
Expand All@@ -2131,10 +2085,8 @@ mod tests {
 }
 }

 if primary_namespace == SCORER_PERSISTENCE_PRIMARY_NAMESPACE
 && secondary_namespace == SCORER_PERSISTENCE_SECONDARY_NAMESPACE
 && key == SCORER_PERSISTENCE_KEY
 {
 if primary_namespace == SCORER_NAMESPACE && key == SCORER_KEY {
 assert_eq!(secondary_namespace, "");
 if let Some((error, message)) = self.scorer_error {
 return Err(std::io::Error::new(error, message).into());
 }
Expand Down

13 changes: 6 additions & 7 deletions
lightning-persister/src/test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ use lightning::ln::functional_test_utils::{
};
use lightning::util::persist::{
	migrate_kv_store_data, read_channel_monitors, KVStoreSync, MigratableKVStore,
KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN,
};
use lightning::util::test_utils;
use lightning::{check_added_monitors, check_closed_broadcast, check_closed_event};
Expand DownExpand Up@@ -46,8 +46,8 @@ pub(crate) fn do_read_write_remove_list_persist<K: KVStoreSync + RefUnwindSafe>(
	assert_eq!(listed_keys.len(), 0);

	// Ensure we have no issue operating with primary_namespace/secondary_namespace/key being
	// KVSTORE_NAMESPACE_KEY_MAX_LEN
	let max_chars = "A".repeat(KVSTORE_NAMESPACE_KEY_MAX_LEN);
	// NAMESPACE_MAX_LEN
	let max_chars = "A".repeat(NAMESPACE_MAX_LEN);
	kv_store.write(&max_chars, &max_chars, &max_chars, data.clone()).unwrap();

	let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
Expand DownExpand Up@@ -76,17 +76,16 @@ pub(crate) fn do_test_data_migration<S: MigratableKVStore, T: MigratableKVStore>
 let primary_namespace = if i == 0 {
 String::new()
 } else {
 format!("testspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(i).unwrap())
 format!("testspace{}", NAMESPACE_ALPHABET.chars().nth(i).unwrap())
 };
 for j in 0..num_secondary_namespaces {
 let secondary_namespace = if i == 0 || j == 0 {
 String::new()
 } else {
 format!("testsubspace{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(j).unwrap())
 format!("testsubspace{}", NAMESPACE_ALPHABET.chars().nth(j).unwrap())
 };
 for k in 0..num_keys {
 let key =
 format!("testkey{}", KVSTORE_NAMESPACE_KEY_ALPHABET.chars().nth(k).unwrap());
 let key = format!("testkey{}", NAMESPACE_ALPHABET.chars().nth(k).unwrap());
 source_store
 .write(&primary_namespace, &secondary_namespace, &key, dummy_data.clone())
 .unwrap();
Expand Down

5 changes: 2 additions & 3 deletions
lightning-persister/src/utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
use lightning::types::string::PrintableString;
use lightning::util::persist::{KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN};
use lightning::util::persist::{NAMESPACE_ALPHABET, NAMESPACE_MAX_LEN};

pub(crate) fn is_valid_kvstore_str(key: &str) -> bool {
	key.len() <= KVSTORE_NAMESPACE_KEY_MAX_LEN
 && key.chars().all(|c| KVSTORE_NAMESPACE_KEY_ALPHABET.contains(c))
	key.len() <= NAMESPACE_MAX_LEN && key.chars().all(|c| NAMESPACE_ALPHABET.contains(c))
}

pub(crate) fn check_namespace_key_validity(
Expand Down
Loading
Loading