Remove spurious universality comment on `KVStore`
What the developer wrote
Authored by Matt Corallo
Remove spurious universality comment on `KVStore`
There would be nothing wrong with passing a different `KVStore` to
`OutputSweeper` from `MonitorUpdatingPersister` (though I'm not
really sure why someone would), and in fact I'm not aware of any
cases where passing a different `KVStore` to different structs
would be problematic. Thus, the sentence in docs is simply removed.
What changed, and why it matters
This commit only removes a misleading documentation comment. It does not change any code behavior, fix a bug, or address a security issue. The previous comment incorrectly warned that using different data stores for different parts of the lightning node could be unsafe; the commit author clarifies that this is not actually a problem.
No action required. This is a documentation cleanup with no security or functional implications.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff deletes seven lines from the rustdoc comments on the KVStore trait in lightning/src/util/persist.rs. The removed text claimed that KVStore implementations should generally be shared by reference across components and that giving OutputSweeper a different KVStore than MonitorUpdatingPersister would be unsafe. The commit message states this warning was unfounded and that no such unsafety exists. No executable code, interfaces, or logic were modified.
Changed components
lightning/src/util/persist.rs documentation onlyInspect captured patch +0 / −7
diff --git a/lightning/src/util/persist.rs b/lightning/src/util/persist.rs
index 440d1d3..1b750c6 100644
--- a/lightning/src/util/persist.rs
+++ b/lightning/src/util/persist.rs
@@ -258,10 +258,6 @@ where
/// namespace, i.e., conflicts between keys and equally named
/// primary namespaces/secondary namespaces must be avoided.
///
-/// Instantiations of this trait should generally be shared by reference across the lightning
-/// node's components. E.g., it would be unsafe to provide a different [`KVStore`] to
-/// [`OutputSweeper`] vs [`MonitorUpdatingPersister`].
-///
/// **Note:** Users migrating custom persistence backends from the pre-v0.0.117 `KVStorePersister`
/// interface can use a concatenation of `[{primary_namespace}/[{secondary_namespace}/]]{key}` to
/// recover a `key` compatible with the data model previously assumed by `KVStorePersister::persist`.
@@ -269,9 +265,6 @@ where
/// For a synchronous version of this trait, see [`KVStoreSync`].
///
/// This is not exported to bindings users as async is only supported in Rust.
-///
-/// [`OutputSweeper`]: crate::util::sweep::OutputSweeper
-/// [`MonitorUpdatingPersister`]: crate::util::persist::MonitorUpdatingPersister
// Note that updates to documentation on this trait should be copied to the synchronous version.
pub trait KVStore {
/// Returns the data stored for the given `primary_namespace`, `secondary_namespace`, and
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.