Skip to content

Clarify and consolidate event handling requirements #1697

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.

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

Conversation

TheBlueMatt
Copy link
Collaborator

We've seen a bit of user confusion about the requirements for event handling, largely because the idempotency and consistency requirements weren't super clearly phrased. While we're at it, we also consolidate some documentation out of the event handling function onto the trait itself.

Fixes #1675.

We've seen a bit of user confusion about the requirements for event
handling, largely because the idempotency and consistency
requirements weren't super clearly phrased. While we're at it, we
also consolidate some documentation out of the event handling
function onto the trait itself.

Fixes lightningdevkit#1675.
@codecov-commenter
Copy link

Codecov Report

Merging #1697 (ce7e7d3) into main (8c6cb99) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1697      +/-   ##
==========================================
- Coverage   90.88%   90.84%   -0.05%     
==========================================
  Files          86       86              
  Lines       46304    46304              
  Branches    46304    46304              
==========================================
- Hits        42085    42066      -19     
- Misses       4219     4238      +19     
Impacted Files Coverage Δ
lightning/src/ln/channelmanager.rs 84.98% <ø> (-0.03%) ⬇️
lightning/src/util/events.rs 39.77% <ø> (+0.27%) ⬆️
lightning/src/chain/onchaintx.rs 93.79% <0.00%> (-1.15%) ⬇️
lightning/src/ln/payment_tests.rs 98.57% <0.00%> (-0.32%) ⬇️
lightning/src/ln/functional_tests.rs 96.84% <0.00%> (-0.18%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@wpaulino
Copy link
Contributor

wpaulino commented Sep 6, 2022

Somewhat unrelated, as I was going through this, I noticed we support serializing HTLCHandlingFailed events, but not deserializing them. Is this expected?

@TheBlueMatt
Copy link
Collaborator Author

Ouch, how the hell did that get past review :(

Copy link
Contributor

@valentinewallace valentinewallace left a comment

Choose a reason for hiding this comment

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

Big improvement IMO

@valentinewallace valentinewallace merged commit 301efc8 into lightningdevkit:main Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify and Unify event handling documentation
4 participants