Skip to content

Commit e72c5ee

Browse files
committed
f struct docs
1 parent d2ea0a1 commit e72c5ee

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1130,6 +1130,12 @@ impl_writeable_tlv_based_enum!(EventCompletionAction,
11301130
}
11311131
);
11321132

1133+
/// The source argument which is passed to [`ChannelManager::claim_mpp_part`].
1134+
///
1135+
/// This is identical to [`MPPClaimHTLCSource`] except that [`Self::counterparty_node_id`] is an
1136+
/// `Option`, whereas it is required in [`MPPClaimHTLCSource`]. In the future, we should ideally
1137+
/// drop this and merge the two, however doing so may break upgrades for nodes which have pending
1138+
/// forwarded payments.
11331139
struct HTLCClaimSource {
11341140
counterparty_node_id: Option<PublicKey>,
11351141
funding_txo: OutPoint,
@@ -1150,7 +1156,8 @@ impl From<&MPPClaimHTLCSource> for HTLCClaimSource {
11501156

11511157
#[derive(Clone, Debug, PartialEq, Eq)]
11521158
/// The source of an HTLC which is being claimed as a part of an incoming payment. Each part is
1153-
/// tracked in [`PendingMPPClaim`].
1159+
/// tracked in [`PendingMPPClaim`] as well as in [`ChannelMonitor`]s, so that it can be converted
1160+
/// to an [`HTLCClaimSource`] for claim replays on startup.
11541161
struct MPPClaimHTLCSource {
11551162
counterparty_node_id: PublicKey,
11561163
funding_txo: OutPoint,

0 commit comments

Comments
 (0)