This repository was archived by the owner on Aug 5, 2026. It is now read-only.
chore: Update RPC configuration guidance and validation - #890
Merged
lightwalker-eth merged 16 commits intoAug 7, 2025
Merged
Conversation
- Enhanced comments in docker-compose and example files to clarify the need for proper RPC endpoint configuration. - Updated .env.local.example files to emphasize the requirement for private (paid) RPC services. - Added validation in the ENSIndexer startup process to ensure critical RPC configurations are set, with clear error messages for missing configurations. - Improved documentation to highlight the performance limitations of public RPC endpoints.
🦋 Changeset detectedLatest commit: 37e3edd The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
tk-o
reviewed
Jul 26, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances RPC configuration guidance and validation for ENSIndexer to ensure proper setup with private (paid) RPC endpoints. The changes address performance issues caused by users attempting to use public rate-limited RPC endpoints that cannot handle the high-volume requests required by ENSIndexer.
- Added startup validation to check for required RPC configurations and provide clear error messages
- Enhanced documentation and example files to emphasize the need for private RPC services
- Updated default rate limits and comments to reflect proper infrastructure requirements
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| apps/ensindexer/src/config/index.ts | Added startup validation function to check for required RPC configurations |
| apps/ensindexer/src/config/config.schema.ts | Enhanced schema validation with better error messages for RPC configurations |
| apps/ensindexer/.env.local.example | Updated with comprehensive guidance on RPC endpoint requirements |
| docs/ensnode.io/src/content/docs/ensindexer/usage/configuration.mdx | Added critical warning section about RPC configuration requirements |
| docker-compose.yml | Enhanced comments to clarify configuration requirements |
| examples/example-docker-compose/docker-compose.yml | Enhanced comments to clarify configuration requirements |
| apps/ensadmin/.env.local.example | Updated RPC URL guidance for consistency |
| apps/ensindexer/src/lib/lib-config.ts | Added clarifying comments about rate limit assumptions |
| .changeset/many-coins-wait.md | Added changeset entry for the updates |
Comments suppressed due to low confidence (1)
apps/ensindexer/src/config/config.schema.ts:140
- [nitpick] The error message is too verbose and could be clearer. Consider breaking this into multiple lines or simplifying the message to focus on the immediate action needed.
"No RPC configurations found. You must configure RPC endpoints for the chains required by your enabled plugins. See .env.local.example for guidance. Public (rate limited) RPC endpoints will not provide acceptable performance - use only private (paid) endpoints.",
tk-o
reviewed
Jul 26, 2025
…ecause it is done in config schema
djstrong
commented
Jul 26, 2025
djstrong
commented
Jul 26, 2025
- Added example for using Alchemy as an RPC provider in the configuration file. - Clarified the requirement for the Ethereum Mainnet RPC URL when using the subgraph plugin.
…c-endpoints-and-rate-limits
…-and-rate-limits' of https://github.com/namehash/ensnode into 340-improve-the-default-configuration-for-rpc-endpoints-and-rate-limits
lightwalker-eth
deleted the
340-improve-the-default-configuration-for-rpc-endpoints-and-rate-limits
branch
August 7, 2025 13:37
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves: