Skip to content

docs-sync v3.0.1: WS page, error codes, public /rpc/evm route, x-batch-ids fix - #9

Merged
gtupak merged 3 commits into
masterfrom
docs-sync/v3.0.1
Aug 28, 2026
Merged

docs-sync v3.0.1: WS page, error codes, public /rpc/evm route, x-batch-ids fix#9
gtupak merged 3 commits into
masterfrom
docs-sync/v3.0.1

Conversation

@maia-cloud-agent

@maia-cloud-agent maia-cloud-agent Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the documentation to align with RouteMesh v3.0.1 and includes the following changes:

New Public RPC Endpoint Documentation

  • Added documentation for a new public JSON-RPC proxy endpoint (POST /rpc/evm/{chainId}) that allows anonymous access without an API key, subject to per-IP rate limits
  • Added example in the quick-start guide showing how to make requests to this public route
  • Documented the rate limits and guidance to sign up for a free account when limits are hit

New WebSocket API Documentation

  • Added a new "WebSocket API" section documenting real-time event streaming support
  • Covers connection setup using wss://lb.routeme.sh/rpc/{chain_id}/{api_key}
  • Documents the eth_subscribe/eth_unsubscribe protocol with code examples
  • Lists handshake failure scenarios and their HTTP status codes (402, 429, 503, 401)
  • Provides details on supported subscription types, pricing, and reliability features including seamless failover and gap backfill

Expanded RPC Error Code Reference

  • Added 10 new error codes to the documentation:
    • -32601: Insufficient credits
    • -32007: No block-param capable nodes
    • -32008: No providers available
    • -32009: All nodes failed
    • -32011: No opcode-capable nodes
    • -32012: Insufficient historical state depth
    • -32013: No single provider satisfies all constraints
    • -32029: Public rate limited
    • -32030: Public capacity exhausted
  • Updated descriptions for existing error codes (e.g., -32602 now also covers overly large responses)

Bug Fix: X-Batch-Id Documentation

  • Corrected the documentation for batch requests: instead of one X-Batch-Id for the entire batch, there's now one X-Batch-Ids header containing comma-separated batch IDs for each item in the batch

@maia-cloud-agent
maia-cloud-agent Bot requested a review from gtupak August 28, 2026 20:09
@kodus-routemesh-hosted

This comment has been minimized.

Comment thread intro/rpc-error-codes.mdx Outdated
@kodus-routemesh-hosted

kodus-routemesh-hosted Bot commented Aug 28, 2026

Copy link
Copy Markdown

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.

  • Validate Business Logic: Ask Kody to validate your code against business rules by adding a comment with the @kody -v business-logic command.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug
Performance
Security
Business Logic

Access your configuration settings here.

@gtupak
gtupak merged commit 6dde1e4 into master Aug 28, 2026
3 checks passed
@gtupak
gtupak deleted the docs-sync/v3.0.1 branch August 28, 2026 20:17
@diff-guardian

diff-guardian Bot commented Aug 28, 2026

Copy link
Copy Markdown

Diff Guardian — addressing summary

Addressed

  • intro/rpc-error-codes.mdx — corrected -32601 description to state it is the JSON-RPC 2.0 "Method not found" code, repurposed here to signal an empty credit balance (commit 0aa6666).

Tests

  • npx mintlify validate — passed
  • npx mintlify broken-links — passed (no broken links)

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.

1 participant