Skip to content

Fix bogus Event::PaymentSent serialization #973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2021
Merged

Fix bogus Event::PaymentSent serialization #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# 0.0.99 - WIP

## Serialization Compatibility

* Due to a bug discovered in 0.0.98, if a `ChannelManager` is serialized on
version 0.0.98 while an `Event::PaymentSent` is pending processing, the
`ChannelManager` will fail to deserialize both on version 0.0.98 and later
versions. If you have such a `ChannelManager` available, a simple patch will
Copy link

@ariard ariard Jun 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would the patch ? Adding back a payment.preimage: Readable::read(reader)?

Copy link
Collaborator Author

@TheBlueMatt TheBlueMatt Jun 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, just reading (and throwing away) an extra 32 bytes.

allow it to deserialize, please file an issue if you need assistance.

# 0.0.98 - 2021-06-11

0.0.98 should be considered a release candidate to the first alpha release of
Expand Down
1 change: 0 additions & 1 deletion lightning/src/util/events.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,6 @@ impl Writeable for Event {
write_tlv_fields!(writer, {
(0, payment_preimage, required),
});
payment_preimage.write(writer)?;
Copy link
Contributor

@valentinewallace valentinewallace Jun 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Darn! If anyone wants to post-mortem, this seems to be the commit where this occurred: 263bf9e#diff-3b5c370b404e2f5a8f3c35093b97406f149a9340c177c05252574083d68df0daR160-R163 At least serialization was a bit of a one-off big PR.

Copy link
Collaborator Author

@TheBlueMatt TheBlueMatt Jun 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, good thing we have fuzzers (when I remember to check their output...).

Copy link

@ariard ariard Jun 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAICT, it was introduced by #935 ?

Copy link
Collaborator Author

@TheBlueMatt TheBlueMatt Jun 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I believe so.

},
&Event::PaymentFailed { ref payment_hash, ref rejected_by_dest,
#[cfg(test)]
Expand Down