Skip to content

Commit 5622a33

Browse files
fixup: be more specific on doc when explaining about older monitors and stuff prior to ldk 0.2
1 parent bd70a4f commit 5622a33

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

lightning/src/chain/channelmonitor.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,10 +1188,10 @@ pub(crate) struct ChannelMonitorImpl<Signer: EcdsaChannelSigner> {
11881188
pending_funding: Vec<FundingScope>,
11891189

11901190
/// True if this channel was configured for manual funding broadcasts. Monitors written by
1191-
/// versions prior to introducing the flag will load with `false` until a new update persists it.
1191+
/// versions prior to LDK 0.2 load with `false` until a new update persists it.
11921192
is_manual_broadcast: bool,
1193-
/// True once we've observed either funding transaction on-chain. Older monitors assume
1194-
/// this is `true` when absent during upgrade so holder broadcasts aren't gated unexpectedly.
1193+
/// True once we've observed either funding transaction on-chain. Older monitors prior to LDK 0.2
1194+
/// assume this is `true` when absent during upgrade so holder broadcasts aren't gated unexpectedly.
11951195
/// In manual-broadcast channels we also use this to trigger deferred holder
11961196
/// broadcasts once the funding transaction finally appears on-chain.
11971197
funding_seen_onchain: bool,
@@ -6660,7 +6660,8 @@ impl<'a, 'b, ES: EntropySource, SP: SignerProvider> ReadableArgs<(&'a ES, &'b SP
66606660
},
66616661
pending_funding: pending_funding.unwrap_or(vec![]),
66626662
is_manual_broadcast: is_manual_broadcast.unwrap_or(false),
6663-
// Assume "seen" when absent to prevent gating holder broadcasts after upgrade.
6663+
// Older monitors prior to LDK 0.2 assume this is `true` when absent
6664+
// during upgrade so holder broadcasts aren't gated unexpectedly.
66646665
funding_seen_onchain: funding_seen_onchain.unwrap_or(true),
66656666

66666667
latest_update_id,

0 commit comments

Comments
 (0)