Correct idempotency key docs on `LSPS2ServiceEvent::OpenChannel`
What the developer wrote
Authored by Matt Corallo
Correct idempotency key docs on `LSPS2ServiceEvent::OpenChannel`
While it would be correct to use `(their_network_key,
intercept_scid)` as the idempotency key when handling
`LSPS2ServiceEvent::OpenChannel`, we don't actually expect anyone
to do so as it would require separate storage to track the
`intercept_scid` -> opened channel mappings.
Thus, we update the documentation to note that the correct
idempotency key is `(their_network_key, user_channel_id)`.
What changed, and why it matters
This commit is a one-word documentation correction in a Rust comment. It changes the recommended idempotency key for handling an LSPS2 service event from a temporary routing identifier (intercept_scid) to a stable user-supplied identifier (user_channel_id). There is no code change, no security fix, and no vulnerability.
No security action required. Treat as a normal documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch updates the doc comment on LSPS2ServiceEvent::OpenChannel in lightning-liquidity/src/lsps2/event.rs. It advises implementers to use (their_network_key, user_channel_id) rather than (their_network_key, intercept_scid) as the idempotency key when deciding whether to ignore a replayed channel-open event. The change is purely advisory documentation; no logic, API, or behavior is modified.
Changed components
lightning-liquidity/src/lsps2/event.rs documentationInspect captured patch +1 / −1
diff --git a/lightning-liquidity/src/lsps2/event.rs b/lightning-liquidity/src/lsps2/event.rs
index 29cc577..502429b 100644
--- a/lightning-liquidity/src/lsps2/event.rs
+++ b/lightning-liquidity/src/lsps2/event.rs
@@ -163,7 +163,7 @@ pub enum LSPS2ServiceEvent {
///
/// **Note: ** As this event is persisted and might get replayed after restart, you'll need to
/// ensure channel creation idempotency. I.e., please check if you already created a
- /// corresponding channel based on the given `their_network_key` and `intercept_scid` and
+ /// corresponding channel based on the given `their_network_key` and `user_channel_id` and
/// ignore this event in case you did.
///
/// [`ChannelManager::create_channel`]: lightning::ln::channelmanager::ChannelManager::create_channel
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.