Add note about checksumed addresses in event object

[moose-code]

Summary

• clarify address casing in the Event object docs

Testing

• yarn build (fails: package not present in lockfile)

Summary by CodeRabbit

• Documentation
  • Added a tip explaining that all addresses in event data use the EIP-55 checksum format and suggesting the use of .toLowerCase() if lowercase addresses are needed.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
envio-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 22, 2025 9:09am

[coderabbitai]

Walkthrough

A new informational tip was added to the "Additional Event Information" section of the documentation, clarifying that all addresses in the event object use the EIP-55 checksum format and suggesting the use of .toLowerCase() for lowercase requirements. No code or logic was modified.

Changes

File(s)	Change Summary
docs/HyperIndex/Guides/event-handlers.mdx	Added a tip about address formatting (EIP-55 checksum) in event objects and advice on lowercasing

Poem

In docs a tip began to grow,
About addresses you should know—
EIP-55, checksummed and neat,
For every event, a formatting treat!
If lowercase is what you seek,
.toLowerCase() will do the tweak.
🐇✨

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[moose-code]

Closes #640

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/HyperIndex/Guides/event-handlers.mdx (1)

203-203: Nit: refine phrasing for clarity
Consider replacing “returned in the event object” with “contained in the event object” or simply “in the event object” to improve readability:

All addresses contained in the event object, such as …

🧰 Tools

🪛 LanguageTool

[grammar] ~203-~203: The usual collocation for “returned” is “to”, not “in”.
Context: ...mpty by default). :::tip All addresses returned in the event object, such as `event.tran...

(RETURN_IN_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 59c9bf3 and e92d2f4.

📒 Files selected for processing (1)

• docs/HyperIndex/Guides/event-handlers.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/HyperIndex/Guides/event-handlers.mdx

[grammar] ~203-~203: The usual collocation for “returned” is “to”, not “in”.
Context: ...mpty by default). :::tip All addresses returned in the event object, such as `event.tran...

(RETURN_IN_THE)

🔇 Additional comments (1)

docs/HyperIndex/Guides/event-handlers.mdx (1)

202-207: Helpful tip on checksumed addresses
This new :::tip block clearly informs users that event.transaction.from, event.transaction.to, and event.srcAddress use the EIP-55 checksum format and guides them to apply .toLowerCase() when lowercase is needed. Great addition for clarity!

🧰 Tools

🪛 LanguageTool

[grammar] ~203-~203: The usual collocation for “returned” is “to”, not “in”.
Context: ...mpty by default). :::tip All addresses returned in the event object, such as `event.tran...

(RETURN_IN_THE)