Clarify event style usage #636
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughA clarification was added to both the configuration guide and the event schema description regarding event definition styles. Users are now explicitly instructed to use either human-readable event signatures or ABI event names consistently within a contract configuration, and warned against mixing both styles to prevent errors. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
closes #355 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
static/schemas/config.evm.json (1)
153-155: Align style and improve readability in schema description.Consider updating the description text to:
- Use "human-readable" with a hyphen
- Capitalize "JSON" instead of "json"
- Use the standard "e.g.," abbreviation instead of "eg."
- Replace the dash before "do not mix" with a semicolon for clarity
For example:
- "description": "The human readable signature of an event 'eg. Transfer(address indexed from, address indexed to, uint256 value)' OR a reference to the name of an event in a json ABI file defined in your contract config. A provided signature will take precedence over what is defined in the json ABI. Use either signatures or ABI event names consistently - do not mix both styles.", + "description": "The human-readable signature of an event (e.g., Transfer(address indexed from, address indexed to, uint256 value)) or a reference to the name of an event in a JSON ABI file defined in your contract config. A provided signature takes precedence over what is defined in the JSON ABI; use either human-readable signatures or ABI event names consistently; do not mix both styles.",docs/HyperIndex/Guides/configuration-file.mdx (1)
98-102: Refine wording for clarity and consistency in the docs.To improve flow and align with the schema description, consider:
:::important Choose **one** event definition style. Use either event names from an ABI file or human-readable event signatures. Do not mix both styles within the same contract, as this is unsupported and can cause errors. :::
- Merges broken lines for readability
- Matches phrasing with the JSON schema ("event names from an ABI file")
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (2)
docs/HyperIndex/Guides/configuration-file.mdx(1 hunks)static/schemas/config.evm.json(1 hunks)
| :::important | ||
| Choose **one** event definition style. Use either names from an ABI file *or* | ||
| human‑readable event signatures. Mixing both in the same contract isn’t | ||
| supported and can cause errors. | ||
| ::: |
Summary
Testing
yarn build(fails: package missing)Summary by CodeRabbit