Skip to content

Docs for V3 alpha 5#773

Merged
DZakh merged 1 commit intomainfrom
dz/v3-alpha-5
Jan 6, 2026
Merged

Docs for V3 alpha 5#773
DZakh merged 1 commit intomainfrom
dz/v3-alpha-5

Conversation

@DZakh
Copy link
Member

@DZakh DZakh commented Jan 6, 2026

Summary by CodeRabbit

  • New Features

    • Conditional event handlers with eventFilters capability
    • Automatic contract configuration for chains
    • ClickHouse Sink (experimental) support
    • Enhanced TUI with improved visuals and behavior
  • Documentation

    • Updated v3 migration guide with new Indexer API and public types
    • Updated Solana quickstart to alpha.5
  • Updates

    • Added Fraxtal and Sei network support
    • Removed Base Traces from supported networks

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Jan 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
envio-docs Ready Ready Preview, Comment Jan 6, 2026 3:48pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 6, 2026

📝 Walkthrough

Walkthrough

This pull request updates documentation and configuration data for the Envio tooling platform. Changes include expanding the HyperIndex v3 migration guide with new public API types and features, bumping Solana and dependency versions to alpha.5, removing Base Traces network support, and adding Fraxtal and Sei network entries across multiple documentation and configuration files.

Changes

Cohort / File(s) Summary
HyperIndex v3 Migration
docs/HyperIndex/migrate-to-v3.md
Reworded section headers (e.g., "Chain Info on Context" → "Chain State on Context"), introduced new public API types (Indexer, EvmChainId, FuelChainId, SvmChainId), documented indexer value replacing getGeneratedByChainId, added "Conditional Event Handlers" and "Automatic Contract Configuration" sections, introduced "ClickHouse Sink (Experimental)" and "TUI Improvements" sections, updated dependency versions from alpha.4 to alpha.5, removed RPC for Live Indexing configuration block.
Solana Documentation
docs/HyperIndex/solana/solana.md
Updated Quickstart command from pnpx envio@3.0.0-alpha.4 init svm to pnpx envio@3.0.0-alpha.5 init svm.
Network Support Tables
docs/HyperRPC/hyperrpc-supported-networks.md, docs/HyperSync/hypersync-supported-networks.md
Removed "Base Traces" network row; added "Fraxtal" (ID 252) and "Sei" (ID 1329) network entries to tables with corresponding URLs and tier indicators.
Network Configuration
supported-networks.json
Added two new network entries: "supported-networks/fraxtal" and "supported-networks/sei".

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • #763: Directly modifies and expands docs/HyperIndex/migrate-to-v3.md with API guidance and type documentation changes.
  • #730: Updates supported networks data in supported-networks.json and network documentation tables.
  • #756: Modifies docs/HyperIndex/solana/solana.md with version and command updates.

Suggested reviewers

  • DenhamPreen
  • moose-code
  • JasoonS

Poem

🐰 New networks hop into view,
Fraxtal, Sei join the alpha crew!
Types shine bright, indexer leads the way,
Migration docs guide us through v3's day!
From alpha.4 to alpha.5 we soar,
Envio's garden opens its door. 🌿✨

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Docs for V3 alpha 5' directly corresponds to the main objective of updating documentation for the V3 alpha 5 release, covering version bumps, new API features, and configuration changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI Agents
In @docs/HyperRPC/hyperrpc-supported-networks.md:
- Line 78: Documentation lists Fraxtal and Sei RPC endpoints that return HTTP
403 and are inaccessible; update the HyperRPC supported networks list by either
removing the Fraxtal and Sei rows or investigating and replacing the endpoints
with working ones. Specifically, check the entries for "Fraxtal" (network id
252, endpoints fraxtal.rpc.hypersync.xyz and 252.rpc.hypersync.xyz) and "Sei"
(network id 1329, endpoints sei.rpc.hypersync.xyz and 1329.rpc.hypersync.xyz)
and then either delete those table rows or update them with validated,
accessible endpoints and a note about access restrictions if intentional.

In @docs/HyperSync/hypersync-supported-networks.md:
- Line 86: The Fraxtal and Sei entries in the networks table are reported
non-functional (HTTP 403); update the table rows for the networks labeled
"Fraxtal" (ID 252) and "Sei" (ID 1329) by either removing those rows entirely or
downgrading their tier emojis to a lower-tier indicator (e.g., 🥉 or 🎒) and
adjust/remove their endpoint URLs (https://fraxtal.hypersync.xyz /
https://252.hypersync.xyz and the Sei URL) so the documentation reflects their
inaccessible status; ensure the changes target the table rows containing the
exact network names "Fraxtal" and "Sei" and IDs 252 and 1329.
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c2c34b9 and 878455d.

⛔ Files ignored due to path filters (1)
  • static/img/sync.gif is excluded by !**/*.gif
📒 Files selected for processing (5)
  • docs/HyperIndex/migrate-to-v3.md
  • docs/HyperIndex/solana/solana.md
  • docs/HyperRPC/hyperrpc-supported-networks.md
  • docs/HyperSync/hypersync-supported-networks.md
  • supported-networks.json
🧰 Additional context used
🧠 Learnings (2)
📚 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/HyperRPC/hyperrpc-supported-networks.md
  • supported-networks.json
  • docs/HyperSync/hypersync-supported-networks.md
📚 Learning: 2025-07-29T14:32:31.665Z
Learnt from: DenhamPreen
Repo: enviodev/docs PR: 673
File: LLM_DOCS_README.md:24-32
Timestamp: 2025-07-29T14:32:31.665Z
Learning: The Envio documentation build system requires Yarn and does not work with pnpm, despite other parts of the repository potentially using pnpm/pnpx. The LLM documentation commands (yarn build-llm, yarn start-llm, yarn consolidate-docs) must remain using yarn to function properly.

Applied to files:

  • docs/HyperIndex/solana/solana.md
🪛 LanguageTool
docs/HyperIndex/migrate-to-v3.md

[style] ~144-~144: Consider using a different verb for a more formal wording.
Context: ...ng all globally defined contracts. This fixes an issue where addContract crashed be...

(FIX_RESOLVE)

🪛 markdownlint-cli2 (0.18.1)
docs/HyperRPC/hyperrpc-supported-networks.md

78-78: Bare URL used

(MD034, no-bare-urls)


78-78: Bare URL used

(MD034, no-bare-urls)


117-117: Bare URL used

(MD034, no-bare-urls)


117-117: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (8)
docs/HyperIndex/solana/solana.md (1)

21-21: LGTM! Version bump is consistent.

The update from alpha.4 to alpha.5 aligns with the PR objectives for the V3 alpha 5 release.

docs/HyperIndex/migrate-to-v3.md (6)

78-108: Excellent documentation of the new indexer API.

The new sections clearly document the chain state context and indexer API with practical code examples. The transition from getGeneratedByChainId to the indexer value is well explained, and the introduction of the new types (Indexer, EvmChainId, FuelChainId, SvmChainId) is clear.


110-140: Clear explanation of conditional event handlers.

The conditional event handler feature is well documented with a practical example showing how to return boolean values or filter arrays based on chain IDs. This is a useful addition to the API.


142-165: Automatic contract configuration is clearly explained.

The YAML example effectively demonstrates how UniswapV3Pool no longer needs explicit configuration when defined globally. This simplification will improve developer experience.


196-196: Version references are consistent throughout.

All references to the alpha version have been correctly updated to 3.0.0-alpha.5, including the Solana init command, package.json example, migration checklist, and release notes links.

Also applies to: 305-305, 487-487, 528-533


223-227: Nice documentation of TUI improvements.

The updated TUI section clearly communicates the improvements. The animated GIF reference will help users understand the visual enhancements.


463-463: Migration path from getGeneratedByChainId is clear.

The references to using indexer.chains[chainId] instead of getGeneratedByChainId are consistently documented in both the detailed guide and the quick checklist, making the migration path clear for developers.

Also applies to: 512-512

supported-networks.json (1)

80-80: No issues found. Both Fraxtal (Chain ID 252) and Sei (Chain ID 1329) have properly formatted documentation files with correct network IDs, functional HyperSync and HyperRPC endpoints, and are correctly positioned in alphabetical order within supported-networks.json.

| Ethereum Mainnet | 1 | https://eth.rpc.hypersync.xyz or https://1.rpc.hypersync.xyz |
| Fantom | 250 | https://fantom.rpc.hypersync.xyz or https://250.rpc.hypersync.xyz |
| Flare | 14 | https://flare.rpc.hypersync.xyz or https://14.rpc.hypersync.xyz |
| Fraxtal | 252 | https://fraxtal.rpc.hypersync.xyz or https://252.rpc.hypersync.xyz |
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify that the HyperRPC endpoints for Fraxtal and Sei are accessible

echo "Testing Fraxtal endpoint (Network ID: 252)..."
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" --max-time 10 \
  https://fraxtal.rpc.hypersync.xyz || echo "Failed to connect"

echo ""
echo "Testing Fraxtal endpoint by ID (252)..."
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" --max-time 10 \
  https://252.rpc.hypersync.xyz || echo "Failed to connect"

echo ""
echo "Testing Sei endpoint (Network ID: 1329)..."
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" --max-time 10 \
  https://sei.rpc.hypersync.xyz || echo "Failed to connect"

echo ""
echo "Testing Sei endpoint by ID (1329)..."
curl -s -o /dev/null -w "HTTP Status: %{http_code}\n" --max-time 10 \
  https://1329.rpc.hypersync.xyz || echo "Failed to connect"

Repository: enviodev/docs

Length of output: 293


Remove or investigate Fraxtal and Sei entries - endpoints are not accessible.

Verification reveals all Fraxtal and Sei HyperRPC endpoints return HTTP 403 (Forbidden), indicating they are not accessible. Both the named endpoints (fraxtal.rpc.hypersync.xyz, sei.rpc.hypersync.xyz) and ID-based endpoints (252.rpc.hypersync.xyz, 1329.rpc.hypersync.xyz) are blocked. These entries should either be removed from the documentation or investigated to determine if access has been intentionally restricted or if the endpoints are no longer operational.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

78-78: Bare URL used

(MD034, no-bare-urls)


78-78: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In @docs/HyperRPC/hyperrpc-supported-networks.md at line 78, Documentation lists
Fraxtal and Sei RPC endpoints that return HTTP 403 and are inaccessible; update
the HyperRPC supported networks list by either removing the Fraxtal and Sei rows
or investigating and replacing the endpoints with working ones. Specifically,
check the entries for "Fraxtal" (network id 252, endpoints
fraxtal.rpc.hypersync.xyz and 252.rpc.hypersync.xyz) and "Sei" (network id 1329,
endpoints sei.rpc.hypersync.xyz and 1329.rpc.hypersync.xyz) and then either
delete those table rows or update them with validated, accessible endpoints and
a note about access restrictions if intentional.

| Ethereum Mainnet | 1 | https://eth.hypersync.xyz or https://1.hypersync.xyz | 🏅 |
| Fantom | 250 | https://fantom.hypersync.xyz or https://250.hypersync.xyz | 🪨 |
| Flare | 14 | https://flare.hypersync.xyz or https://14.hypersync.xyz | 🪨 |
| Fraxtal | 252 | https://fraxtal.hypersync.xyz or https://252.hypersync.xyz | 🪨 |
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Test Fraxtal and Sei HyperSync endpoints
echo "Testing Fraxtal HyperSync endpoint (Network ID: 252)..."
curl -s -o /dev/null -w "fraxtal.hypersync.xyz - HTTP Status: %{http_code}\n" --max-time 10 https://fraxtal.hypersync.xyz

echo "Testing Fraxtal HyperSync endpoint by ID (252)..."
curl -s -o /dev/null -w "252.hypersync.xyz - HTTP Status: %{http_code}\n" --max-time 10 https://252.hypersync.xyz

echo "Testing Sei HyperSync endpoint (Network ID: 1329)..."
curl -s -o /dev/null -w "sei.hypersync.xyz - HTTP Status: %{http_code}\n" --max-time 10 https://sei.hypersync.xyz

echo "Testing Sei HyperSync endpoint by ID (1329)..."
curl -s -o /dev/null -w "1329.hypersync.xyz - HTTP Status: %{http_code}\n" --max-time 10 https://1329.hypersync.xyz

Repository: enviodev/docs

Length of output: 415


🏁 Script executed:

# Find and examine the file context
fd "hypersync-supported-networks.md" -t f

# Get the file and show lines around 86 and 125
if git ls-files | grep -q "hypersync-supported-networks.md"; then
  echo "=== Context around line 86 ==="
  sed -n '80,92p' docs/HyperSync/hypersync-supported-networks.md
  echo ""
  echo "=== Context around line 125 ==="
  sed -n '119,131p' docs/HyperSync/hypersync-supported-networks.md
fi

Repository: enviodev/docs

Length of output: 3963


Remove or downgrade Fraxtal and Sei entries — HyperSync endpoints are non-functional (HTTP 403).

Both Fraxtal (252) and Sei (1329) endpoints return HTTP 403 Forbidden status, indicating they are inaccessible and non-functional. These should either be removed from the documentation or downgraded to a lower tier (🥉 or 🎒) to reflect their unavailability, consistent with how non-functional endpoints are handled in this guide.

🤖 Prompt for AI Agents
In @docs/HyperSync/hypersync-supported-networks.md at line 86, The Fraxtal and
Sei entries in the networks table are reported non-functional (HTTP 403); update
the table rows for the networks labeled "Fraxtal" (ID 252) and "Sei" (ID 1329)
by either removing those rows entirely or downgrading their tier emojis to a
lower-tier indicator (e.g., 🥉 or 🎒) and adjust/remove their endpoint URLs
(https://fraxtal.hypersync.xyz / https://252.hypersync.xyz and the Sei URL) so
the documentation reflects their inaccessible status; ensure the changes target
the table rows containing the exact network names "Fraxtal" and "Sei" and IDs
252 and 1329.

@nikbhintade nikbhintade self-requested a review January 6, 2026 16:10
@DZakh DZakh merged commit 14ec5bf into main Jan 6, 2026
3 checks passed
@DZakh DZakh deleted the dz/v3-alpha-5 branch January 6, 2026 18:35
@DenhamPreen DenhamPreen mentioned this pull request Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants