Skip to content

Conversation

@JasoonS
Copy link
Contributor

@JasoonS JasoonS commented Jan 22, 2026

image

Spills over onto 2 lines now, but seems fine

Summary by CodeRabbit

  • Documentation
    • Restructured the supported networks reference table to display both HyperSync and HyperRPC endpoint URLs for each network in a consolidated view. The enhanced layout provides simultaneous access to both service endpoints, replacing the previous single URL column format and improving endpoint accessibility.

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

@JasoonS JasoonS requested a review from DZakh January 22, 2026 16:38
@vercel
Copy link

vercel bot commented Jan 22, 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 22, 2026 4:39pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 22, 2026

📝 Walkthrough

Walkthrough

The changes reorganize the HyperSync supported networks documentation by splitting the single URL column into separate HyperSync URL and HyperRPC URL columns, and update the corresponding endpoint-generation script to output both values for each network entry.

Changes

Cohort / File(s) Summary
Documentation Table Restructuring
docs/HyperSync/hypersync-supported-networks.md
Expanded network table from 4 to 5 columns, renaming "URL" to "HyperSync URL" and adding new "HyperRPC URL" column. Each network row now includes both endpoint types. Removed inline HyperRPC note from header and consolidated notes into dedicated Notes section.
Endpoint Generation Script
scripts/update-endpoints.js
Updated table column definitions and row data construction to use separate hypersyncUrl and hyperrpcUrl variables instead of single url variable, aligning with documentation table restructure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • DenhamPreen
  • keenbeen32
  • DZakh

Poem

🐰 Split the columns, left and right,
HyperSync and HyperRPC take flight!
URLs double, endpoints align,
Documentation now looks fine ✨

🚥 Pre-merge checks | ✅ 3
✅ 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 accurately describes the main change: combining HyperSync and HyperRPC URLs into a single unified table instead of separate representations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

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: 1

🤖 Fix all issues with AI agents
In `@docs/HyperSync/hypersync-supported-networks.md`:
- Around line 31-32: The generated Markdown table is missing a preceding blank
line; update the updateMarkdownFiles function so it inserts a single blank line
(newline) between the closing block (e.g. the ::: container) and the table
header when composing or writing the file, ensuring the table is surrounded by
blank lines to satisfy MD058; locate the logic that concatenates or renders the
section containing the table header ("| Network Name ... |") and add the blank
line insertion or trim/ensure a trailing newline on the previous block before
appending the table.
🧹 Nitpick comments (1)
scripts/update-endpoints.js (1)

158-161: Consider extracting URL generation to reduce duplication.

The traces network handling and URL construction logic is duplicated between generateHyperSyncTable (lines 128-131) and generateHyperRPCTable (lines 159-161). A small helper function could consolidate this.

♻️ Optional refactor
+const generateNetworkUrls = (chain) => {
+  const isTracesNetwork = chain.name.toLowerCase().includes("traces");
+  const chainIdSuffix = isTracesNetwork ? `-traces` : "";
+  return {
+    hypersyncUrl: `https://${chain.name}.hypersync.xyz or https://${chain.chain_id}${chainIdSuffix}.hypersync.xyz`,
+    hyperrpcUrl: `https://${chain.name}.rpc.hypersync.xyz or https://${chain.chain_id}${chainIdSuffix}.rpc.hypersync.xyz`,
+  };
+};

Then use const { hypersyncUrl, hyperrpcUrl } = generateNetworkUrls(chain); in both table generators.

Comment on lines +31 to +32
| Network Name | Network ID | HyperSync URL | HyperRPC URL | Tier |
| ------------------------- | --------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---- |
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 | 🟡 Minor

Add a blank line before the table.

Static analysis (MD058) correctly identifies that the table should be surrounded by blank lines. There's no blank line between the closing ::: on line 30 and the table header on line 31.

📝 Proposed fix
 If you are a network operator or user and would like improved service support or to discuss upgrading a chain's level of support, please reach out to us in [Discord](https://discord.gg/Q9qt8gZ2fX).
 :::
+
 | Network Name              | Network ID      | HyperSync URL                                                                            | HyperRPC URL                                                                             | Tier |

Note: This fix should be applied in the script's updateMarkdownFiles function to ensure the blank line is consistently generated.

📝 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
| Network Name | Network ID | HyperSync URL | HyperRPC URL | Tier |
| ------------------------- | --------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---- |
:::
| Network Name | Network ID | HyperSync URL | HyperRPC URL | Tier |
| ------------------------- | --------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---- |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

31-31: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

🤖 Prompt for AI Agents
In `@docs/HyperSync/hypersync-supported-networks.md` around lines 31 - 32, The
generated Markdown table is missing a preceding blank line; update the
updateMarkdownFiles function so it inserts a single blank line (newline) between
the closing block (e.g. the ::: container) and the table header when composing
or writing the file, ensuring the table is surrounded by blank lines to satisfy
MD058; locate the logic that concatenates or renders the section containing the
table header ("| Network Name ... |") and add the blank line insertion or
trim/ensure a trailing newline on the previous block before appending the table.

Copy link
Member

@DZakh DZakh left a comment

Choose a reason for hiding this comment

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

Nice, let's update HyperRPC page as well

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.

3 participants