Skip to content

chore: add fallback RPC #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 26, 2025
Merged

chore: add fallback RPC #105

merged 5 commits into from
Mar 26, 2025

Conversation

thelostone-mc
Copy link
Contributor

@thelostone-mc thelostone-mc commented Mar 24, 2025

🤖 Linear

Closes PAR-946

Description

Checklist before requesting a review

  • I have conducted a self-review of my code.
  • I have conducted a QA.
  • If it is a core feature, I have included comprehensive tests.

Summary by CodeRabbit

  • New Features
    • Enhanced blockchain connectivity with updated endpoints and fallback options across multiple networks.
    • Introduced a sample environment configuration template to simplify user setup.
  • Chores
    • Improved the container build process by updating package management support.
  • Documentation
    • Revised user guidance to recommend fallback configurations, helping to mitigate potential connectivity issues.

Copy link

coderabbitai bot commented Mar 24, 2025

📝 Walkthrough

Walkthrough

The pull request updates configuration and documentation files for the indexer application. New RPC endpoints using environment variable fallbacks have been added or updated in the configuration file to support multiple blockchain networks including Mainnet, Optimism, Lukso, Gnosis, Polygon, Fantom, Zksync Era, Metis, Base, Arbitrum, Avalanche, Celo, Scroll, and Sepolia. The Dockerfile now installs the latest version of Corepack globally and introduces minor formatting improvements. Additionally, a new .env.example file has been added to provide a template with environment variable declarations for both custom and fallback RPC URLs. An update to the README file includes a note on the potential unreliability of Hypersync and directs users to check the .env.example file to verify that the necessary RPC variables are set before deployment.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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: 0

🧹 Nitpick comments (1)
.env.example (1)

30-30: Clarify the placeholder value for ENVIO_ALCHEMY_API_KEY.

The new environment variable is added as a generic placeholder (ALCHEMY_API_KEY), which is consistent with the naming convention. For enhanced clarity, consider updating the placeholder to something more descriptive, for example YOUR_ALCHEMY_API_KEY_HERE, and/or add an inline comment that instructs users to replace it with their actual Alchemy API key.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a119d66 and 7f40ea6.

📒 Files selected for processing (1)
  • .env.example (1 hunks)

@thelostone-mc thelostone-mc force-pushed the fallback-rpc branch 4 times, most recently from daa4e57 to 568c1f9 Compare March 25, 2025 14:18
Copy link

@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: 0

🧹 Nitpick comments (1)
apps/indexer/README.md (1)

73-73: Enhance Fallback RPC Note Clarity

The newly added note clearly communicates the importance of providing a fallback RPC given Hypersync's potential unreliability. It also thoughtfully directs users to check the .env.example file to ensure that all necessary environment variables are set before deployment.

While the note is concise and on point, you might consider adding a brief explanation of what issues could arise when Hypersync fails (or a link to further documentation) to assist users who may be less familiar with the concept of fallback RPCs. This minor addition could further improve clarity and usefulness.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 82469c5 and 38a7997.

📒 Files selected for processing (4)
  • Dockerfile (1 hunks)
  • apps/indexer/.env.example (1 hunks)
  • apps/indexer/README.md (1 hunks)
  • apps/indexer/config.yaml (11 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/indexer/.env.example
🚧 Files skipped from review as they are similar to previous changes (2)
  • Dockerfile
  • apps/indexer/config.yaml
⏰ Context from checks skipped due to timeout of 300000ms (1)
  • GitHub Check: e2e-tests / E2E Tests

@thelostone-mc thelostone-mc merged commit 5724ea6 into dev Mar 26, 2025
8 checks passed
@thelostone-mc thelostone-mc deleted the fallback-rpc branch March 26, 2025 06:46
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