Skip to content

Commit 0cef8dc

Browse files
committed
f - Clarify changelog downgrade note
Reword the backwards-compatibility note to call out that the downgrade risk is limited to users who (1) manually persist `Event::OnionMessageIntercepted` events and (2) opt in to the new `intercept_for_unknown_scids` flag on `OnionMessenger::new_with_offline_peer_interception`. LDK itself does not persist these events, so anyone who doesn't persist them manually is unaffected regardless of the flag. Co-Authored-By: HAL 9000
1 parent b973585 commit 0cef8dc

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
## Backwards Compatibility
22

3-
When downgrading to LDK v0.2 and prior, `OnionMessageIntercepted` events that
4-
hold the new `NextMessageHop::ShortChannelId` will fail to be deserialized and
5-
hence will be discarded.
3+
If you manually persist `Event::OnionMessageIntercepted` events and construct
4+
your `OnionMessenger` via `OnionMessenger::new_with_offline_peer_interception`
5+
with `intercept_for_unknown_scids` set to `true`, you may not be able to
6+
downgrade to LDK v0.2 or prior: persisted events carrying the new
7+
`NextMessageHop::ShortChannelId` next hop will fail to deserialize on the
8+
older version.
9+
10+
LDK does not persist `OnionMessageIntercepted` events itself. Users who do
11+
not persist these events manually, or who leave `intercept_for_unknown_scids`
12+
disabled, are unaffected.

0 commit comments

Comments
 (0)