Trivial: document some fields on MonitorRestoreUpdates
What the developer wrote
Authored by Valentine Wallace
Trivial: document some fields on MonitorRestoreUpdates
What changed, and why it matters
This commit only adds plain-text documentation comments to two fields inside an internal data structure. No code behavior was changed, and there is no security effect.
No action needed; this is a non-functional documentation change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds two rustdoc comments to fields on the MonitorRestoreUpdates struct in lightning/src/ln/channel.rs: one for commitment_update and one for pending_update_adds. The change is purely documentation; no logic, types, visibility, or control flow were modified.
Changed components
lightning/src/ln/channel.rsInspect captured patch +3 / −0
diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 2762ab6..8e69430 100644
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -1137,11 +1137,14 @@ pub enum UpdateFulfillCommitFetch {
/// The return value of `monitor_updating_restored`
pub(super) struct MonitorRestoreUpdates {
pub raa: Option<msgs::RevokeAndACK>,
+ /// A `CommitmentUpdate` to be sent to our channel peer.
pub commitment_update: Option<msgs::CommitmentUpdate>,
pub commitment_order: RAACommitmentOrder,
pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
pub finalized_claimed_htlcs: Vec<(HTLCSource, Option<AttributionData>)>,
+ /// Inbound update_adds that are now irrevocably committed to this channel and are ready for the
+ /// onion to be processed in order to forward or receive the HTLC.
pub pending_update_adds: Vec<msgs::UpdateAddHTLC>,
pub funding_broadcastable: Option<Transaction>,
pub channel_ready: Option<msgs::ChannelReady>,
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.