Skip to content
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

Add Lava RPC Endpoints to Mainnet Beta and Mocha Testnet Documentation #1856

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

ignacio-rsg
Copy link
Contributor

@ignacio-rsg ignacio-rsg commented Jan 13, 2025

Add Lava RPC Endpoints to Mainnet Beta and Mocha Testnet Documentation

This pull request updates the documentation for both Mainnet Beta and Mocha Testnet to include new RPC endpoints provided by Lava.

Mainnet Beta

  1. Community JSON-RPC Endpoints

    • Added a new section with the endpoint celestia.jsonrpc.lava.build.
  2. Community Tendermint RPC Endpoints

    • Added a new section with the endpoint celestia.tendermintrpc.lava.build.
  3. Community API Endpoints

    • Added celestia.rest.lava.build to the existing list.
  4. Community gRPC Endpoints

    • Added celestia.grpc.lava.build:443 to the existing list.

Mocha Testnet

  1. Community JSON-RPC Endpoints

    • Added a new section with the endpoint celestiam.jsonrpc.lava.build.
  2. Community Tendermint RPC Endpoints

    • Added a new section with the endpoint celestiam.tendermintrpc.lava.build.
  3. Community API Endpoints

    • Added celestiam.rest.lava.build to the existing list.
  4. Community gRPC Endpoints

    • Added celestiam.grpc.lava.build:443 to the existing list.

Summary by CodeRabbit

  • New Features
    • Added new community endpoints for Celestia Mainnet Beta
    • Added multiple community RPC endpoints for Mocha Testnet, including:
      • REST API
      • gRPC
      • JSON-RPC
      • Tendermint RPC endpoints

Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Walkthrough

This pull request updates documentation for Celestia's network endpoints by adding new community RPC endpoints. For the Mainnet Beta, a new gRPC endpoint celestia.grpc.lava.build:443 is introduced. The Mocha Testnet documentation receives more comprehensive updates, including new endpoints for API, gRPC, JSON-RPC, and Tendermint RPC services, expanding connection options for network participants.

Changes

File Changes
how-to-guides/mainnet.md Added community gRPC endpoint celestia.grpc.lava.build:443
how-to-guides/mocha-testnet.md Added multiple community endpoints:
- REST API: http://celestiam.rest.lava.build
- gRPC: celestiam.grpc.lava.build:443
- JSON-RPC: celestiam.jsonrpc.lava.build
- Tendermint RPC: celestiam.tendermintrpc.lava.build

Possibly related PRs

Suggested reviewers

  • jcstein

Poem

🚀 Endpoints Dancing Free

Rabbit hops through gRPC's domain,
Mainnet, Mocha - connections gain!
New paths to connect, explore, and see
Network magic, setting data free! 🌐

- CodeRabbit's Endpoint Poetry 🐰


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 46403eb and a44001d.

📒 Files selected for processing (2)
  • how-to-guides/mainnet.md (2 hunks)
  • how-to-guides/mocha-testnet.md (2 hunks)
🔇 Additional comments (2)
how-to-guides/mocha-testnet.md (1)

178-187: LGTM! Consistent endpoint naming

The new Lava endpoints follow a consistent naming pattern with the 'celestiam' prefix for the Mocha testnet, making it clear these are testnet endpoints.

how-to-guides/mainnet.md (1)

175-176: LGTM! Consistent endpoint naming

The new Lava endpoints follow a consistent naming pattern with the 'celestia' prefix for mainnet, making it clear these are mainnet endpoints.

Also applies to: 197-198

@@ -149,6 +149,7 @@ The default port is 1317.
- [https://celestia-testnet-api.itrocket.net](https://celestia-testnet-api.itrocket.net)
- [https://api-celestia-testnet.cryptech.com.ua](https://api-celestia-testnet.cryptech.com.ua)
- [https://celestia-t-api.noders.services](https://celestia-t-api.noders.services)
- [http://celestiam.rest.lava.build](http://celestiam.rest.lava.build)
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider using HTTPS for the API endpoint

The API endpoint is using HTTP which is less secure. Consider using HTTPS instead for enhanced security.

- - [http://celestiam.rest.lava.build](http://celestiam.rest.lava.build)
+ - [https://celestiam.rest.lava.build](https://celestiam.rest.lava.build)
📝 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
- [http://celestiam.rest.lava.build](http://celestiam.rest.lava.build)
- [https://celestiam.rest.lava.build](https://celestiam.rest.lava.build)

Comment on lines +197 to +198
- `celestia.grpc.lava.build:443`

Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Missing JSON-RPC and Tendermint RPC endpoints confirmed

The review comment is correct. The mainnet documentation is missing the following Lava endpoints:

  • celestia.jsonrpc.lava.build
  • celestia.tendermintrpc.lava.build
🔗 Analysis chain

Missing JSON-RPC and Tendermint RPC endpoints

According to the PR objectives, JSON-RPC and Tendermint RPC endpoints should be added for both networks. These endpoints are missing for the mainnet:

  • celestia.jsonrpc.lava.build
  • celestia.tendermintrpc.lava.build
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify if sections for JSON-RPC and Tendermint RPC endpoints exist in the file
rg -i "json-rpc|tendermint rpc" how-to-guides/mainnet.md

Length of output: 58


Script:

#!/bin/bash
# Get the content of mainnet.md and testnet.md if exists
echo "=== Content of mainnet.md ==="
cat how-to-guides/mainnet.md

echo -e "\n=== Searching for endpoint-related content in testnet docs ==="
fd testnet.md --exec cat {}

echo -e "\n=== Searching for any endpoint references ==="
rg -i "endpoint|rpc|\.build" how-to-guides/

Length of output: 66917


Script:

#!/bin/bash
# Search specifically for jsonrpc and tendermintrpc patterns in mainnet.md
echo "=== Searching for JSON-RPC and Tendermint RPC endpoints ==="
rg -i "jsonrpc\.lava\.build|tendermintrpc\.lava\.build" how-to-guides/mainnet.md

echo -e "\n=== Checking if there are dedicated sections for these endpoint types ==="
rg -i "## .*(json-rpc|tendermint rpc).*endpoints" how-to-guides/mainnet.md

Length of output: 451

@jcstein jcstein merged commit 7d0910e into celestiaorg:main Jan 15, 2025
2 checks passed
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