Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documents newly supported notifier event types (including new WebSocket Type values) and regenerates the LLM static export, plus a small typo fix in validator rating docs.
Changes:
- Document 4 additional notifier event payloads: Block Txs, Block Scrs, Block Events, Block State Accesses.
- Extend the documented WebSocket
Typeenum values to includeblock_txs,block_scrs,block_events,block_state_accesses. - Fix a spelling mistake in the validators rating documentation and regenerate
static/llms-full.txt.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| static/llms-full.txt | Regenerated static export reflecting the newly documented notifier event types/payload fields. |
| docs/validators/rating.md | Fixes “unsuccessfuly” → “unsuccessfully”. |
| docs/sdk-and-tools/notifier.md | Adds documentation for new notifier event types, WS type values, and payload field tables. |
Comments suppressed due to low confidence (2)
docs/sdk-and-tools/notifier.md:400
- Minor grammar/capitalization: "In Websocket setup, there is a event type field" should be "In WebSocket setup, there is an event type field".
- `Block State Accesses event`: when the block is committed, it contains the state accesses for the block
In RabbitMQ there is a separate exchange for each event type.
In Websocket setup, there is a event type field in each message.
static/llms-full.txt:16900
- Minor grammar/capitalization: "In Websocket setup, there is a event type field" should be "In WebSocket setup, there is an event type field".
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
static/llms-full.txt
Outdated
| | timestamp | The timestamp field represents the creation time of the block (in seconds). | | ||
| | timestampMs | The timestampMs field represents the creation time of the block (in milliseconds). | | ||
| | txs | The txs field holds a map of transactions, where the key is the transaction hash. | | ||
| | scrs | The scrs field holds a map of smart contract results, where the key is the scr hash. | |
There was a problem hiding this comment.
In the scrs field description, the key is described as "the scr hash". Elsewhere in this document you use "smart contract result hash"; using consistent terminology here would be clearer.
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
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.
Description of the pull request (what is new / what has changed)
Did you test the changes locally ?
Did you regenerate static/llms.txt and static/llms-full.txt ? (happens at build time)
Which category (categories) does this pull request belong to?