Provide the same docs in `ChangeDestinationSource` as the sync one
What the developer wrote
Authored by Matt Corallo
Provide the same docs in `ChangeDestinationSource` as the sync one
What changed, and why it matters
This commit only adds a documentation comment to a Rust trait method. It does not change any code behavior, logic, or security properties. The added text explains that the method returns a script pubkey usable as a change destination and references another function.
No action needed; this is a documentation-only change with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds a three-line doc comment to ChangeDestinationSourceSync::get_change_destination_script in lightning/src/sign/mod.rs, mirroring documentation already present on the async ChangeDestinationSource trait. There are no code changes, no API changes, and no functional or security impact.
Changed components
lightning/src/sign/mod.rs documentationInspect captured patch +3 / −0
diff --git a/lightning/src/sign/mod.rs b/lightning/src/sign/mod.rs
index 8a5aceb..1d771d2 100644
--- a/lightning/src/sign/mod.rs
+++ b/lightning/src/sign/mod.rs
@@ -1071,6 +1071,9 @@ pub trait ChangeDestinationSource {
/// A synchronous helper trait that describes an on-chain wallet capable of returning a (change) destination script.
pub trait ChangeDestinationSourceSync {
+ /// Returns a script pubkey which can be used as a change destination for
+ /// [`OutputSpender::spend_spendable_outputs`].
+ ///
/// This method should return a different value each time it is called, to avoid linking
/// on-chain funds controlled to the same user.
fn get_change_destination_script(&self) -> Result<ScriptBuf, ()>;
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.