Skip to content

Clarify event style usage #636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify event style usage #636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/HyperIndex/Guides/configuration-file.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,12 @@ events:
- event: "ClearGreeting(address user)"
```

:::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.
:::
Comment on lines +98 to +102
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's supported though 🤔


By default, all events defined in the contract are indexed, but you can selectively disable them by removing them from this list.

#### Custom Event Names
Expand Down
2 changes: 1 addition & 1 deletion static/schemas/config.evm.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@
"type": "object",
"properties": {
"event": {
"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",
"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.",
"type": "string"
},
"name": {
Expand Down