Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis pull request adds Status Sepolia network support documentation across HyperRPC, HyperSync, and HyperIndex services, introduces a comprehensive Query Conversion Guide for migrating from TheGraph's custom GraphQL syntax to Envio's standard GraphQL, and updates navigation configuration to reflect these new documentation entries. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/HyperIndex/Guides/query-conversion.md (1)
11-11: Consider tightening the phrasing on introduction.The phrase "important differences to be aware of when migrating" is slightly verbose. Consider alternatives like "important differences to note when migrating" or "important differences you should know about" for more concise writing.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/HyperIndex/Guides/query-conversion.mddocs/HyperIndex/migration-guide.mddocs/HyperRPC/hyperrpc-supported-networks.mddocs/HyperSync/hypersync-supported-networks.mdsidebarsHyperIndex.js
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/HyperIndex/migration-guide.md
- sidebarsHyperIndex.js
- docs/HyperRPC/hyperrpc-supported-networks.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-29T14:30:03.677Z
Learnt from: DenhamPreen
Repo: enviodev/docs PR: 673
File: docs/HyperIndex/supported-networks/chainweb-testnet-21.md:14-16
Timestamp: 2025-07-29T14:30:03.677Z
Learning: Chainweb Testnet 20 (ID: 5920) and Chainweb Testnet 21 (ID: 5921) have non-functional HyperSync endpoints that return HTTP 404, indicating these networks are not properly supported and should be removed from documentation.
Applied to files:
docs/HyperSync/hypersync-supported-networks.md
🪛 LanguageTool
docs/HyperIndex/Guides/query-conversion.md
[style] ~11-~11: To make your writing concise, consider an alternative.
Context: ...there are some important differences to be aware of when migrating. This guide covers all ...
(AWARE_OF)
[grammar] ~26-~26: Ensure spelling is correct
Context: ...exer. This allows you to continue using TheGraph query syntax without making any changes...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~311-~311: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 5081 characters long)
Context: ..., BigDecimal|String, numeric|$id: ID!→$id: String!` | --- ## Getting Help If you encoun...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
docs/HyperSync/hypersync-supported-networks.md
95-95: Bare URL used
(MD034, no-bare-urls)
95-95: Bare URL used
(MD034, no-bare-urls)
96-96: Bare URL used
(MD034, no-bare-urls)
96-96: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (10)
docs/HyperIndex/Guides/query-conversion.md (9)
15-32: Converter tool section is well-structured and informative.The section effectively introduces the converter tool, provides repository access, explains the hosted endpoint option for dedicated tier users, and includes appropriate beta warnings with issue reporting links. Clear and actionable guidance for users.
36-79: Entity name conversion rules are clear with practical examples.The examples effectively demonstrate the conversion from TheGraph's pluralized camelCase (pools, factories, tokens) to Envio's singular PascalCase (Pool, Factory, Token), including both the
_by_pksyntax andwhereclause alternatives. This gives users flexibility in how they structure their queries.
81-117: Pagination parameter conversions are accurate and well-documented.The
first→limitandskip→offsetconversions are correctly described with clear examples. The distinction between the two approaches is helpful for migration.
119-139: Ordering syntax consolidation is correctly explained.The consolidation of separate
orderByandorderDirectionparameters into a singleorder_by: {field: direction}object is accurately documented with examples for both ascending and descending order.
141-189: Filter operators section provides comprehensive conversion mappings.The equality, comparison, and negation operators are thoroughly covered with correct mappings:
field: value→field: {_eq: value}_not,_not_in→_neq,_nin- Comparison operators (
_gt,_gte,_lt,_lte,_in) correctly preservedThe examples are practical and demonstrate the nesting structure clearly.
191-223: String filter conversions are accurate with proper wildcard usage.The mapping of TheGraph's string operators to Envio's
_ilikewith wildcard patterns is correctly documented:
_contains→_ilike: "%text%"_starts_with→_ilike: "text%"_ends_with→_ilike: "%text"- Negations using
_notwrapper are correctly shownThe examples cover both case-sensitive and case-insensitive variations. Well structured.
225-297: Variable type conversions are comprehensive and accurate.The mappings correctly specify the type system changes:
ID→StringBytes→StringBigInt→numericBigDecimal→numericEach conversion includes practical query examples showing the parameter usage in context. The distinction between required (
!) and optional types is preserved in the examples.
301-311: Summary table provides excellent quick reference.The summary table effectively condenses all conversion rules into an easy-to-scan format with category, TheGraph syntax, Envio syntax, and examples. Users can quickly locate relevant conversions without reading the full sections.
315-320: Getting Help section provides clear support pathways.Directs users to file GitHub issues for converter-specific problems and Discord for general questions. Appropriate triage and clear call-to-action links.
docs/HyperSync/hypersync-supported-networks.md (1)
95-95: The bare URL linting concern applies to the entire table, not just these new entries.Lines 95 (Hoodi) and 97 (Injective) follow the identical URL pattern used consistently across all 87+ network entries in the table. If MD034 violations are a concern, they should be addressed project-wide, not singled out for new additions. Review the existing entries (Chiliz, Citrea Testnet, etc.) which use the same bare URL style, or confirm whether this pattern is intentionally accepted for markdown table formatting in your documentation standards.
Likely an incorrect or invalid review comment.
keenbeen32
force-pushed
the
kv/query-converter
branch
from
f6318b4 to
c7e2c83
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@docs/HyperIndex/migration-guide.md`:
- Line 199: The "Query Conversion Guide" hyperlink in the migration guide
currently points to /docs/HyperIndex/query-conversion which will 404; locate the
link by finding the "Query Conversion Guide" anchor text in
docs/HyperIndex/migration-guide.md and update its href to the correct route
(either /query-conversion if the guide lives at the site root or
/docs/HyperIndex/Advanced/query-conversion if it should remain under
HyperIndex), or convert the href to a relative slug that resolves under the new
docs structure so the link no longer breaks.
In `@docs/HyperIndex/supported-networks/status-sepolia.md`:
- Around line 47-49: The YAML list under the key address: is not indented as a
child of that key; update the two list lines starting with -
"0xYourContractAddress1" and - "0xYourContractAddress2" so they are indented one
additional level beneath address: (i.e., add the appropriate spaces so the '-'
lines are nested under the address key) to produce valid YAML.
In `@docs/HyperSync/hypersync-supported-networks.md`:
- Line 109: The "Status Sepolia" table row lists HyperSync endpoints that return
404; update the row containing "Status Sepolia" and chain id "1660990954" to
either remove the HyperSync endpoint URLs (https://status-sepolia.hypersync.xyz
and https://1660990954.hypersync.xyz) or mark HyperSync as not available (e.g.,
blank or "N/A") and keep the working HyperRPC endpoints
(https://status-sepolia.rpc.hypersync.xyz or
https://1660990954.rpc.hypersync.xyz); alternatively, remove the entire "Status
Sepolia" entry until HyperSync is deployed and confirm the change in the same
table row entry.
🧹 Nitpick comments (1)
docs/HyperIndex/Advanced/query-conversion.md (1)
11-13: Tighten opening sentences for conciseness.
You can combine the first two sentences to reduce repetition.
| - Use the `unordered_multichain_mode` option to enable unordered multichain mode, this is the most common need for multichain indexing. However comes with tradeoffs worth understanding. Doc here: [unordered multichain mode](../HyperIndex/configuration-file#unordered-multichain-mode) | ||
| - Use wildcard indexing to index by event signatures rather than by contract address. | ||
| - HyperIndex uses the standard graphql query language, where as the subgraph uses a custom query language. You can read about the slight nuances [here](https://docs.sablier.com/api/caveats). (We are working on a basic tool to help with backwards compatibility, please check in with us on discord for it's current status). | ||
| - HyperIndex uses the standard GraphQL query language, whereas TheGraph uses a custom GraphQL syntax. You can read about the differences and how to convert queries in our [Query Conversion Guide](/docs/HyperIndex/query-conversion). We also provide a query converter tool for backwards compatibility with existing TheGraph queries. |
There was a problem hiding this comment.
Potential broken link to Query Conversion Guide.
The new guide’s slug is /query-conversion (in the added doc), but this link points to /docs/HyperIndex/query-conversion. That mismatch likely 404s. Consider updating the link to the actual route or removing the absolute slug in the guide so it lives under /docs/HyperIndex/Advanced/query-conversion.
🤖 Prompt for AI Agents
In `@docs/HyperIndex/migration-guide.md` at line 199, The "Query Conversion Guide"
hyperlink in the migration guide currently points to
/docs/HyperIndex/query-conversion which will 404; locate the link by finding the
"Query Conversion Guide" anchor text in docs/HyperIndex/migration-guide.md and
update its href to the correct route (either /query-conversion if the guide
lives at the site root or /docs/HyperIndex/Advanced/query-conversion if it
should remain under HyperIndex), or convert the href to a relative slug that
resolves under the new docs structure so the link no longer breaks.
| address: | ||
| - "0xYourContractAddress1" | ||
| - "0xYourContractAddress2" |
There was a problem hiding this comment.
Fix YAML list indentation under address:.
The list items should be indented one level deeper than address: to remain valid YAML.
✅ Suggested fix
- address:
- - "0xYourContractAddress1"
- - "0xYourContractAddress2"
+ address:
+ - "0xYourContractAddress1"
+ - "0xYourContractAddress2"📝 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.
| address: | |
| - "0xYourContractAddress1" | |
| - "0xYourContractAddress2" | |
| address: | |
| - "0xYourContractAddress1" | |
| - "0xYourContractAddress2" |
🤖 Prompt for AI Agents
In `@docs/HyperIndex/supported-networks/status-sepolia.md` around lines 47 - 49,
The YAML list under the key address: is not indented as a child of that key;
update the two list lines starting with - "0xYourContractAddress1" and -
"0xYourContractAddress2" so they are indented one additional level beneath
address: (i.e., add the appropriate spaces so the '-' lines are nested under the
address key) to produce valid YAML.
| | Sonic Testnet | 14601 | https://sonic-testnet.hypersync.xyz or https://14601.hypersync.xyz | https://sonic-testnet.rpc.hypersync.xyz or https://14601.rpc.hypersync.xyz | 🎒 | | ||
| | Sophon | 50104 | https://sophon.hypersync.xyz or https://50104.hypersync.xyz | https://sophon.rpc.hypersync.xyz or https://50104.rpc.hypersync.xyz | 🪨 | | ||
| | Sophon Testnet | 531050104 | https://sophon-testnet.hypersync.xyz or https://531050104.hypersync.xyz | https://sophon-testnet.rpc.hypersync.xyz or https://531050104.rpc.hypersync.xyz | 🎒 | | ||
| | Status Sepolia | 1660990954 | https://status-sepolia.hypersync.xyz or https://1660990954.hypersync.xyz | https://status-sepolia.rpc.hypersync.xyz or https://1660990954.rpc.hypersync.xyz | 🎒 | |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Validate Status Sepolia HyperSync/HyperRPC endpoints.
set -euo pipefail
for url in \
"https://status-sepolia.hypersync.xyz" \
"https://1660990954.hypersync.xyz" \
"https://status-sepolia.rpc.hypersync.xyz" \
"https://1660990954.rpc.hypersync.xyz"
do
echo "Checking $url"
curl -s -o /dev/null -w "%{http_code}\n" "$url"
doneRepository: enviodev/docs
Length of output: 256
🏁 Script executed:
# View the file context around line 109
cat -n docs/HyperSync/hypersync-supported-networks.md | sed -n '100,120p'Repository: enviodev/docs
Length of output: 5180
🌐 Web query:
Status Sepolia blockchain testnet
💡 Result:
Sepolia (Ethereum testnet) appears up and producing finalized blocks as of Feb 5, 2026: Etherscan shows blocks being mined seconds apart (e.g., block #10194331 at 2026-02-05 05:00:00 UTC, “27 secs ago” at crawl time). [1]
Infra/provider health (not the chain itself):
- Alchemy’s Sepolia status page reports “All Systems Operational” (block production, JSON-RPC, websockets). [2]
Notes:
- Sepolia.org’s community RPCs/status page are discontinued (the site states it has been shut down; it points users to Chainlist for other RPCs). [3]
Sources: [1] [2] [3]
🌐 Web query:
Status Sepolia 1660990954 chain testnet
💡 Result:
1660990954 is the chain ID for “Status Network Sepolia” (Status Network Testnet)—an Ethereum-compatible testnet used by Status Network. [1][4]
- Network name: Status Network Testnet / Status Network Sepolia [1][10]
- Chain ID: 1660990954 (0x6300b5ea) [1][10]
- Public RPC:
https://public.sepolia.rpc.status.network[1][2] - Block explorer:
https://sepoliascan.status.network[1][9] - Native token (gas): ETH [1][4]
- Bridge (Sepolia L1 ↔ Status testnet L2):
https://bridge.status.network[1][7]
Note: This is not Ethereum’s Sepolia testnet (Ethereum Sepolia chain ID is 11155111). [11]
Sources: [1] Status docs (network details), [2] Status docs (add network), [4] chainid.network entry, [7] Status bridge docs, [9] Status explorer docs, [10] ChainList entry, [11] Ethereum Sepolia chain ID reference.
Status Sepolia HyperSync endpoints are not deployed. While Status Sepolia is a legitimate testnet (chain ID 1660990954), the HyperSync endpoints return 404 responses (https://status-sepolia.hypersync.xyz and https://1660990954.hypersync.xyz do not exist). The HyperRPC endpoints exist and respond correctly. Either remove this entry until HyperSync support is available for this network, or confirm endpoints are properly configured before merging.
🤖 Prompt for AI Agents
In `@docs/HyperSync/hypersync-supported-networks.md` at line 109, The "Status
Sepolia" table row lists HyperSync endpoints that return 404; update the row
containing "Status Sepolia" and chain id "1660990954" to either remove the
HyperSync endpoint URLs (https://status-sepolia.hypersync.xyz and
https://1660990954.hypersync.xyz) or mark HyperSync as not available (e.g.,
blank or "N/A") and keep the working HyperRPC endpoints
(https://status-sepolia.rpc.hypersync.xyz or
https://1660990954.rpc.hypersync.xyz); alternatively, remove the entire "Status
Sepolia" entry until HyperSync is deployed and confirm the change in the same
table row entry.
2 participants
Added a page in the migrating to envio section on converting queries from thegraph to envio syntax. Includes info on the query converter tool.
Summary by CodeRabbit