Add spec document for event trigger defintions#641
Merged
konradkonrad merged 2 commits intoshutter-network:mainfrom Nov 10, 2025
Merged
Add spec document for event trigger defintions#641konradkonrad merged 2 commits intoshutter-network:mainfrom
konradkonrad merged 2 commits intoshutter-network:mainfrom
Conversation
konradkonrad
added a commit
to shutter-network/shutter-api
that referenced
this pull request
Oct 23, 2025
Links will work only **after** shutter-network/rolling-shutter#641
jannikluhn
approved these changes
Nov 3, 2025
Contributor
jannikluhn
left a comment
jannikluhn
left a comment
There was a problem hiding this comment.
looks good, just two comments where the text could potentially be slightly clearer
|
|
||
| - **Topics (Offsets 0-3)**: The indexed parameters of the event log. A topic is | ||
| referenced by its index (0-3), where offset 0 is topic[0], etc. | ||
| - **Data (Offsets 4+)**: The non-indexed data section of the log. Offset |
Contributor
There was a problem hiding this comment.
For clarification, maybe add that this offset starts at 4 even if there's less than 4 topics.
docs/event.md
Outdated
|
|
||
| ### RLP Encoding Details | ||
|
|
||
| The RLP encoding format for the core structures is: |
Contributor
There was a problem hiding this comment.
Maybe clarify that these object definitions are supposed to be translated into (nested) RLP lists (so an event trigger definition becomes [contract_address, [...]]), but we write them as ordered objects to be able to name the list values.
konradkonrad
force-pushed
the
event_trigger_docs
branch
from
bf3a698 to
55e1c52
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixes #637