Clarify and consolidate event handling requirements #1697
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 Report
@@ 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
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
wpaulino
approved these changes
Sep 6, 2022
Contributor
|
Somewhat unrelated, as I was going through this, I noticed we support serializing |
Collaborator
Author
|
Ouch, how the hell did that get past review :( |
valentinewallace
approved these changes
Sep 7, 2022
Contributor
valentinewallace
left a comment
valentinewallace
left a comment
There was a problem hiding this comment.
Big improvement IMO
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.