add documentation for app defined events #57
Conversation
This file contains 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
ecioppettini
commented
Aug 22, 2024
| @@ -37,7 +37,7 @@ export default async function ( | |||
| blockHeader: BlockHeader, | |||
| randomnessGenerator: Prando, | |||
| dbConn: Pool | |||
| ): Promise<SQLUpdate[]> { | |||
| ): Promise<{ stateTransitions: SQLUpdate[], events: [] }> { | |||
There was a problem hiding this comment.
While writing this I started to wonder if it would be worth to have it accept either {stateTransitions: SQLUpdate[], events: ...} or just SQLUpdate[] to keep the existing code working. We can dynamically check if the returned object is an object with the stateTransitions key, so we could branch on that on the engine's side. It depends on how much do we care about the breaking change and how common is the no-events case I guess.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Document the user facing changes in PaimaStudios/paima-engine#409