Skip to content

Commit 888a519

Browse files
committed
f update docs for forward_htlcs
1 parent cdbb0b0 commit 888a519

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,12 @@ pub(super) struct ChannelHolder<Signer: Sign> {
664664
/// here once the channel is available for normal use, with SCIDs being added once the funding
665665
/// transaction is confirmed at the channel's required confirmation depth.
666666
pub(super) short_to_id: HashMap<u64, [u8; 32]>,
667-
/// short channel id -> forward infos. Key of 0 means payments received
667+
/// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
668+
///
669+
/// Note that because we may have an SCID Alias as the key we can have two entries per channel,
670+
/// though in practice we probably won't be receiving HTLCs for a channel both via the alias
671+
/// and via the classic SCID.
672+
///
668673
/// Note that while this is held in the same mutex as the channels themselves, no consistency
669674
/// guarantees are made about the existence of a channel with the short id here, nor the short
670675
/// ids in the PendingHTLCInfo!

0 commit comments

Comments
 (0)