Skip to content

Kv/websockets#749

Closed
keenbeen32 wants to merge 23 commits intomainfrom
kv/websockets
Closed

Kv/websockets#749
keenbeen32 wants to merge 23 commits intomainfrom
kv/websockets

Conversation

@keenbeen32
Copy link
Collaborator

@keenbeen32 keenbeen32 commented Dec 3, 2025

Added a page for websockets under tutorials section in hyperindex docs.

Included an example on how to use it (tested the example as well).

Summary by CodeRabbit

  • New Features

    • WebSockets support for real-time GraphQL data subscriptions in HyperIndex
    • Optimism network added to HyperSync and HyperRPC supported networks
  • Documentation

    • New WebSockets tutorial with TypeScript examples and setup instructions
    • Enhanced blog posts and guides with additional information about indexing features

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

Jordy-Baby and others added 23 commits December 3, 2025 11:41
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…hain-liquidation-metrics-indexer.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@vercel
Copy link

vercel bot commented Dec 3, 2025

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

Project Deployment Preview Comments Updated (UTC)
envio-docs Ready Ready Preview Comment Dec 3, 2025 10:51am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 3, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This PR adds WebSocket documentation for HyperIndex GraphQL, introduces Optimism to supported network listings, updates sidebar configuration, reformats network configuration JSON for readability, and expands blog post content with marketing materials and duplicate "About Envio" sections.

Changes

Cohort / File(s) Summary
Blog Editorial Additions
blog/2023-08-08-methods-to-query-blockchain-data.md, blog/2023-08-17-what-is-an-indexer.md, blog/2023-08-22-envio-grant-program-is-live.md, blog/2023-09-06-envio-community-update-1.md, blog/2023-09-27-envio-community-update-2.md, blog/2023-10-19-envio-celebrates-first-grantee-project-multi-chain-liquidation-metrics-indexer.md, blog/2023-10-24-indexer-benchmarking-results.md, blog/2023-10-26-envio-community-update-3.md, blog/2023-11-09-powers-of-dedicated-hosting-for-web3-apps.md, blog/2023-11-15-simplify-data-retrieval-multi-chain-dapps.md, blog/2024-02-20-envio-data-indexing-on-lukso.md, blog/2024-05-24-case-study-peppy-finance.md, blog/2024-05-30-envio-community-update-may-2024.md, blog/2024-07-17-case-study-gblast.md, blog/2024-11-08-hosted-service-v2.md, blog/2024-12-18-case-study-zkpass.md, blog/2025-01-21-what-is-a-blockchain-indexer.md, blog/2025-05-16-monad-hackathon-winners-2025.md, blog/2025-06-12-how-to-index-monad-data-using-envio.md
Added "About Envio" sections with marketing copy, expanded content, and duplicated social links and footer paragraphs across blog posts.
Documentation - WebSocket Tutorial
docs/HyperIndex/Tutorials/websockets.md
New documentation page covering WebSocket usage with HyperIndex GraphQL, protocol mapping, TypeScript example, and dependency installation.
Documentation - Network Support
docs/HyperRPC/hyperrpc-supported-networks.md, docs/HyperSync/hypersync-supported-networks.md
Added Optimism network entry to supported networks tables.
Configuration Updates
sidebarsHyperIndex.js
Added "Tutorials/websockets" entry to sidebar Tutorials items.
Data Formatting
supported-networks.json
Reflowed network list from single-line to multi-line format with spacing; no semantic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Areas for attention:

  • Blog posts contain extensive duplicated "About Envio" content and footer social links across 19 files—verify intended duplication vs. unintended repetition
  • WebSocket documentation endpoints and protocol mappings (HTTP→WS, HTTPS→WSS) should be validated for correctness
  • Network addition (Optimism) appears in multiple support files—confirm consistent representation across HyperRPC, HyperSync, and supported-networks.json

Possibly related PRs

Suggested reviewers

  • DenhamPreen
  • moose-code
  • DZakh

Poem

🐰 Our docs now shine with WebSocket glow,
Optimism joins the networks we know,
About Envio spreads (perhaps twice or thrice?),
New sidebars and links—all carefully nice,
With formatting flows and expanded delight! ✨

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch kv/websockets

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55fe6cf and e513227.

📒 Files selected for processing (24)
  • blog/2023-08-08-methods-to-query-blockchain-data.md (1 hunks)
  • blog/2023-08-17-what-is-an-indexer.md (3 hunks)
  • blog/2023-08-22-envio-grant-program-is-live.md (3 hunks)
  • blog/2023-09-06-envio-community-update-1.md (1 hunks)
  • blog/2023-09-27-envio-community-update-2.md (1 hunks)
  • blog/2023-10-19-envio-celebrates-first-grantee-project-multi-chain-liquidation-metrics-indexer.md (3 hunks)
  • blog/2023-10-24-indexer-benchmarking-results.md (6 hunks)
  • blog/2023-10-26-envio-community-update-3.md (2 hunks)
  • blog/2023-11-09-powers-of-dedicated-hosting-for-web3-apps.md (3 hunks)
  • blog/2023-11-15-simplify-data-retrieval-multi-chain-dapps.md (3 hunks)
  • blog/2024-02-20-envio-data-indexing-on-lukso.md (2 hunks)
  • blog/2024-05-24-case-study-peppy-finance.md (1 hunks)
  • blog/2024-05-30-envio-community-update-may-2024.md (2 hunks)
  • blog/2024-07-17-case-study-gblast.md (2 hunks)
  • blog/2024-11-08-hosted-service-v2.md (1 hunks)
  • blog/2024-12-18-case-study-zkpass.md (3 hunks)
  • blog/2025-01-21-what-is-a-blockchain-indexer.md (8 hunks)
  • blog/2025-05-16-monad-hackathon-winners-2025.md (2 hunks)
  • blog/2025-06-12-how-to-index-monad-data-using-envio.md (2 hunks)
  • docs/HyperIndex/Tutorials/websockets.md (1 hunks)
  • docs/HyperRPC/hyperrpc-supported-networks.md (1 hunks)
  • docs/HyperSync/hypersync-supported-networks.md (1 hunks)
  • sidebarsHyperIndex.js (1 hunks)
  • supported-networks.json (1 hunks)

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.

@keenbeen32 keenbeen32 closed this Dec 3, 2025
@keenbeen32 keenbeen32 deleted the kv/websockets branch December 3, 2025 10:57
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