docs: Update v3.0.0-alpha.15 release notes and features#851
Open
docs: Update v3.0.0-alpha.15 release notes and features#851
Conversation
Add new feature sections for getWhere operators (_gte, _lte, _in), block lag configuration, separate runtime metrics endpoint, and double handler registration. Remove experimental label from testing framework. Update version references to alpha.15. https://claude.ai/code/session_01GTMMiVvDveeXrTUtjJGC2r
Instead of a standalone section, the new _gte, _lte, _in operators are now documented within the existing GraphQL-Style getWhere API section. https://claude.ai/code/session_01GTMMiVvDveeXrTUtjJGC2r
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation updates to HyperIndex migration and reference guides: removed "Experimental" from the testing framework header, added Hasura-style Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/HyperIndex-LLM/hyperindex-complete.mdx`:
- Around line 1065-1076: The example claims "similar filters" but the two
ERC20.Transfer.handler registrations lack any eventFilters; update the snippet
to either remove "with similar filters" or add matching eventFilters to both
handler registrations (e.g., use the eventFilters property or equivalent
parameter on ERC20.Transfer.handler) so the example matches the text; locate the
two uses of ERC20.Transfer.handler in the snippet and add identical or similar
eventFilters to each (or remove the phrase) and ensure the documentation text is
adjusted accordingly.
In `@docs/HyperIndex/migrate-to-v3.md`:
- Around line 379-380: Add a migration note that ENVIO_INDEXING_BLOCK_LAG is
removed and replaced by the per-chain config option block_lag: update the
“Environment Variable Changes” list to include ENVIO_INDEXING_BLOCK_LAG
(indicate it’s removed and replaced by block_lag, default 0), and add a
checklist item instructing users to move any ENVIO_INDEXING_BLOCK_LAG settings
into the appropriate chain’s block_lag entry in their config; reference the
symbols block_lag and ENVIO_INDEXING_BLOCK_LAG so readers can locate the
relevant sections.
- Around line 393-405: The sentence claims handlers can be registered "with
similar filters" but the example using ERC20.Transfer.handler has no filter
arguments; either remove "with similar filters" from the sentence or update the
two ERC20.Transfer.handler examples to include example filter params (e.g., a
filter object or predicate passed to handler) to demonstrate registering
multiple handlers with similar filters; reference the ERC20.Transfer.handler
calls and update the surrounding text and examples so they match.
- Line 200: Multiple docs still reference "3.0.0-alpha.14" while the reviewed
diff uses "pnpx envio@3.0.0-alpha.15 init svm"; update every occurrence of the
old version string to "3.0.0-alpha.15" and ensure commands like "pnpx
envio@3.0.0-alpha.15 init svm" and any version declarations/changelog links are
changed accordingly (search for the token "3.0.0-alpha.14" and replace with
"3.0.0-alpha.15" and verify the pnpx command string is consistent).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1a697f9f-ba3f-48fa-b689-864a5d7223fb
📒 Files selected for processing (2)
docs/HyperIndex-LLM/hyperindex-complete.mdxdocs/HyperIndex/migrate-to-v3.md
Comment on lines
+1065
to
+1076
| It's now possible to register multiple handlers for the same event with similar filters: | ||
|
|
||
| ```typescript | ||
| import { ERC20 } from "generated"; | ||
|
|
||
| ERC20.Transfer.handler(async ({ event, context }) => { | ||
| // Your logic here | ||
| }); | ||
|
|
||
| ERC20.Transfer.handler(async ({ event, context }) => { | ||
| // And here | ||
| }); |
Contributor
There was a problem hiding this comment.
Example does not match the “similar filters” claim.
Line 1065 says registration is shown “with similar filters,” but Line 1070 and Line 1074 register handlers without any eventFilters. Please either remove that phrase or include filters in the sample.
✏️ Suggested doc fix
-It's now possible to register multiple handlers for the same event with similar filters:
+It's now possible to register multiple handlers for the same event (including with similar filters):
import { ERC20 } from "generated";
+const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
ERC20.Transfer.handler(async ({ event, context }) => {
// Your logic here
-});
+}, { eventFilters: { from: ZERO_ADDRESS } });
ERC20.Transfer.handler(async ({ event, context }) => {
// And here
-});
+}, { eventFilters: { to: ZERO_ADDRESS } });🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/HyperIndex-LLM/hyperindex-complete.mdx` around lines 1065 - 1076, The
example claims "similar filters" but the two ERC20.Transfer.handler
registrations lack any eventFilters; update the snippet to either remove "with
similar filters" or add matching eventFilters to both handler registrations
(e.g., use the eventFilters property or equivalent parameter on
ERC20.Transfer.handler) so the example matches the text; locate the two uses of
ERC20.Transfer.handler in the snippet and add identical or similar eventFilters
to each (or remove the phrase) and ensure the documentation text is adjusted
accordingly.
docs/HyperIndex/migrate-to-v3.md
Outdated
|
|
||
| ```bash | ||
| pnpx envio@3.0.0-alpha.14 init svm | ||
| pnpx envio@3.0.0-alpha.15 init svm |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify remaining alpha.14 references in docs
rg -n --iglob '*.md' --iglob '*.mdx' '3\.0\.0-alpha\.14|pnpx envio@3\.0\.0-alpha\.14 init svm'Repository: enviodev/docs
Length of output: 567
Update version references from alpha.14 to alpha.15 across all documentation files
Multiple documentation pages still reference 3.0.0-alpha.14 while the reviewed file uses 3.0.0-alpha.15, creating conflicting setup instructions:
docs/HyperIndex/solana/solana.md:21– pnpx commanddocs/HyperIndex-LLM/hyperindex-complete.mdx:873, 1175, 1481, 10939– pnpx commands and version declarationsdocs/HyperIndex/migrate-to-v3.md:811– changelog link reference
Align all references to 3.0.0-alpha.15 for consistency.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/HyperIndex/migrate-to-v3.md` at line 200, Multiple docs still reference
"3.0.0-alpha.14" while the reviewed diff uses "pnpx envio@3.0.0-alpha.15 init
svm"; update every occurrence of the old version string to "3.0.0-alpha.15" and
ensure commands like "pnpx envio@3.0.0-alpha.15 init svm" and any version
declarations/changelog links are changed accordingly (search for the token
"3.0.0-alpha.14" and replace with "3.0.0-alpha.15" and verify the pnpx command
string is consistent).
Comment on lines
+379
to
+380
| A per-chain `block_lag` option to index behind the chain head by a specified number of blocks. Replaces the global `ENVIO_INDEXING_BLOCK_LAG` environment variable. Defaults to 0. This is for advanced use cases — only use it if you know what you're doing. | ||
|
|
Contributor
There was a problem hiding this comment.
Missing migration guidance for ENVIO_INDEXING_BLOCK_LAG removal
Line 379 says block_lag replaces ENVIO_INDEXING_BLOCK_LAG, but the “Environment Variable Changes” list (Lines 442-447) does not include that variable. Please add it there (and ideally in the checklist) so migration steps are consistent and actionable.
Suggested doc fix
### Environment Variable Changes
- Removed `UNSTABLE__TEMP_UNORDERED_HEAD_MODE` environment variable
- Removed `UNORDERED_MULTICHAIN_MODE` environment variable
+- Removed `ENVIO_INDEXING_BLOCK_LAG` environment variable (use per-chain `block_lag` in `config.yaml`)
- Removed `MAX_BATCH_SIZE` environment variable (use `full_batch_size` in config.yaml instead)Also applies to: 442-447
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/HyperIndex/migrate-to-v3.md` around lines 379 - 380, Add a migration
note that ENVIO_INDEXING_BLOCK_LAG is removed and replaced by the per-chain
config option block_lag: update the “Environment Variable Changes” list to
include ENVIO_INDEXING_BLOCK_LAG (indicate it’s removed and replaced by
block_lag, default 0), and add a checklist item instructing users to move any
ENVIO_INDEXING_BLOCK_LAG settings into the appropriate chain’s block_lag entry
in their config; reference the symbols block_lag and ENVIO_INDEXING_BLOCK_LAG so
readers can locate the relevant sections.
Comment on lines
+393
to
+405
| It's now possible to register multiple handlers for the same event with similar filters: | ||
|
|
||
| ```typescript | ||
| import { ERC20 } from "generated"; | ||
|
|
||
| ERC20.Transfer.handler(async ({ event, context }) => { | ||
| // Your logic here | ||
| }); | ||
|
|
||
| ERC20.Transfer.handler(async ({ event, context }) => { | ||
| // And here | ||
| }); | ||
| ``` |
Contributor
There was a problem hiding this comment.
Example text and code don’t match on “similar filters”
Line 393 says handlers can be registered “with similar filters,” but both examples on Lines 398-404 have no filters. Either add filter args to the examples or drop “with similar filters” from the sentence.
Suggested doc wording fix
-It's now possible to register multiple handlers for the same event with similar filters:
+It's now possible to register multiple handlers for the same event:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| It's now possible to register multiple handlers for the same event with similar filters: | |
| ```typescript | |
| import { ERC20 } from "generated"; | |
| ERC20.Transfer.handler(async ({ event, context }) => { | |
| // Your logic here | |
| }); | |
| ERC20.Transfer.handler(async ({ event, context }) => { | |
| // And here | |
| }); | |
| ``` | |
| It's now possible to register multiple handlers for the same event: | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/HyperIndex/migrate-to-v3.md` around lines 393 - 405, The sentence claims
handlers can be registered "with similar filters" but the example using
ERC20.Transfer.handler has no filter arguments; either remove "with similar
filters" from the sentence or update the two ERC20.Transfer.handler examples to
include example filter params (e.g., a filter object or predicate passed to
handler) to demonstrate registering multiple handlers with similar filters;
reference the ERC20.Transfer.handler calls and update the surrounding text and
examples so they match.
Add updated dev Docker flow section, ENVIO_PG_PUBLIC_SCHEMA rename to ENVIO_PG_SCHEMA in environment variable changes, and bump version references to alpha.16. https://claude.ai/code/session_01GTMMiVvDveeXrTUtjJGC2r
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.
Summary
Updated migration and documentation to reflect v3.0.0-alpha.15 release, including new features and clarifications about the testing framework status.
Key Changes
_gte,_lte,_in) for querying entitiesblock_lagconfiguration option to index behind the chain head/metrics/runtimeendpoint with dedicated Prometheus registryNotable Details
migrate-to-v3.mdandhyperindex-complete.mdxhttps://claude.ai/code/session_01GTMMiVvDveeXrTUtjJGC2r
Summary by CodeRabbit
New Features
_gte,_lte,_infilter operatorsblock_lagconfiguration/metrics/runtimePrometheus endpointDocumentation
Breaking Changes