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 WebSocket endpoints Cumulo #1741

Merged
merged 2 commits into from
Oct 1, 2024
Merged

Add WebSocket endpoints Cumulo #1741

merged 2 commits into from
Oct 1, 2024

Conversation

santosdios
Copy link
Contributor

@santosdios santosdios commented Sep 30, 2024

Overview

Summary by CodeRabbit

  • New Features

    • Updated documentation for Celestia’s Mainnet Beta, detailing network stability, upgrades, and parameters.
    • Expanded information on transaction limits and block size calculations.
    • Added a comprehensive list of production RPC endpoints and community consensus nodes.
    • Enhanced resources for monitoring network activity and performance.
  • Documentation

    • Included links for users to stay updated on network upgrades via Telegram and Discord.

Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Walkthrough

The documentation for Celestia’s Mainnet Beta has been revised to provide comprehensive details on network stability, upgrades, and parameters. It clarifies that while the network is stable, it is still experimental. Enhancements include expanded information on transaction limits, a list of production RPC endpoints, and updates on community data availability nodes. Additional resources for network tracking and communication channels for updates have also been included.

Changes

Files Change Summary
nodes/mainnet.md Updated to include details on network stability, expanded network parameters, and a list of RPC endpoints. Enhanced sections on explorers and community endpoints.

Possibly related PRs

Suggested reviewers

  • jcstein

Poem

In the land of nodes where data flows,
Celestia shines, as everyone knows.
With upgrades and endpoints, we leap and bound,
A stable network where joy is found.
So hop on in, join the fun,
The Mainnet Beta has just begun! 🐰✨


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

🧹 Outside diff range and nitpick comments (1)
nodes/mainnet.md (1)

224-224: LGTM! Consider minor formatting adjustment for consistency.

The addition of the Cumulo WebSocket endpoint is appropriate and aligns with the PR objectives. The endpoint uses a secure WebSocket connection (wss://), which is suitable for production use.

For consistency with other entries in the list, consider removing the trailing slash from the URL:

- `wss://celestia.cumulo.org.es:443/websocket`
+ `wss://celestia.cumulo.org.es:443/websocket`
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 506aa9a and 7596d02.

📒 Files selected for processing (1)
  • nodes/mainnet.md (1 hunks)
🔇 Additional comments (2)
nodes/mainnet.md (2)

Line range hint 301-303: LGTM! Cumulo endpoints added successfully.

The addition of Cumulo's RPC and gRPC endpoints is consistent with the PR objectives and follows the established format. The use of standard ports (9090 for gRPC and 26657 for RPC) is correct for Celestia nodes.


Line range hint 1-352: Overall, the changes look good and achieve the PR objectives.

The additions of Cumulo's WebSocket, RPC, and gRPC endpoints enhance the documentation by providing users with more options for connecting to the Celestia network. The changes are consistent with the existing format and use appropriate protocols and ports.

@jcstein jcstein enabled auto-merge (squash) September 30, 2024 20:32
@jcstein jcstein enabled auto-merge (squash) September 30, 2024 20:33
@jcstein
Copy link
Member

jcstein commented Oct 1, 2024

gm @santosdios can you pull in latest main to resolve conflicts?

@santosdios santosdios closed this Oct 1, 2024
auto-merge was automatically disabled October 1, 2024 06:28

Pull request was closed

@santosdios santosdios reopened this Oct 1, 2024
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: 1

🧹 Outside diff range and nitpick comments (3)
nodes/mainnet.md (3)

Line range hint 46-86: Approved: Detailed explanation of network parameters added

The addition of detailed information about maximum bytes and calculations for maximum block size is valuable for users and developers. The mathematical formulas and explanations provide a clear understanding of the network's limitations and capabilities.

Consider adding a brief explanation of what PFB stands for in the line "One share is reserved for the PFB transaction" to improve clarity for readers who might not be familiar with the acronym.


Line range hint 103-118: Approved: Production RPC endpoints and usage warning added

The addition of a table listing production RPC providers with their respective URLs is valuable for users deploying in production environments. The warning about not relying on free community endpoints for production deployments is an important precaution that enhances the overall reliability of the documentation.

For consistency, consider using the same format for all URLs in the table. For example, the NewMetric URL could be updated to remove the "https://" prefix to match the format of the other URLs.


Line range hint 284-302: Approved: Additional explorer and analytics resources

The expansion of the explorers and analytics sections with new websites enhances the resources available to users for monitoring and analyzing the Celestia network. This addition improves the overall utility of the documentation.

For consistency, consider adding brief descriptions or categorizations for each explorer and analytics website. This would help users quickly identify which resource best suits their needs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7596d02 and 0f89b38.

📒 Files selected for processing (1)
  • nodes/mainnet.md (1 hunks)
🔇 Additional comments (2)
nodes/mainnet.md (2)

Line range hint 131-153: Approved: Additional community consensus RPC endpoints

The expansion of the community consensus RPC endpoints list is beneficial for users, providing more options for connecting to the network. This addition enhances the overall accessibility and robustness of the Celestia network.


Line range hint 1-310: Overall assessment: Significant improvements to Mainnet Beta documentation

The changes made to this file substantially enhance the Celestia Mainnet Beta documentation. Key improvements include:

  1. Detailed explanations of network parameters and maximum byte calculations.
  2. Addition of production RPC endpoints with appropriate usage warnings.
  3. Expansion of community consensus RPC, API, gRPC, and WebSocket endpoints.
  4. Inclusion of new explorer and analytics resources.

These changes align well with the PR objectives and provide valuable information for users and developers interacting with the Celestia network. The documentation is now more comprehensive and user-friendly.

Comment on lines +199 to +200
- `wss://rpc.celestia.mainnet.dteam.tech:443/websocket`
- `wss://celestia.cumulo.org.es:443/websocket`
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

Issues Found with New WebSocket Endpoints

The newly added WebSocket endpoints could not be connected successfully:

  • wss://celestia-ws.chainode.tech:33373/websocket
  • wss://celestia-mainnet-ws.itrocket.net:443/websocket
  • wss://rpc.celestia.mainnet.dteam.tech:443/websocket
  • wss://celestia.cumulo.org.es:443/websocket

Please verify that these URLs are correct and that the endpoints are accessible.

🔗 Analysis chain

Approved: New WebSocket endpoints added

The addition of new WebSocket endpoints enhances the connectivity options for users and aligns with the PR objective of adding WebSocket endpoints for Cumulo. This improvement contributes to the overall functionality of the Celestia network.

To ensure the consistency and validity of the new WebSocket endpoints, let's verify their format and accessibility:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the format and accessibility of the new WebSocket endpoints

# Test: Check if the URLs follow the expected format
echo "Checking URL format..."
grep -E '^- `wss://.*:.*(/websocket)?`$' nodes/mainnet.md

# Test: Attempt to establish a WebSocket connection (Note: This is a basic check and may not work in all environments)
echo "Attempting to connect to WebSocket endpoints..."
for url in $(grep -oP '(?<=`wss://).*(?=/websocket`)' nodes/mainnet.md); do
    echo "Checking $url..."
    timeout 5 websocat "wss://$url/websocket" 2>/dev/null || echo "Failed to connect to $url"
done

Length of output: 1932

@santosdios
Copy link
Contributor Author

I hope it will be OK some days I hate GitHub :-)

@jcstein
Copy link
Member

jcstein commented Oct 1, 2024

same lol!!

@jcstein jcstein merged commit a8649c1 into celestiaorg:main Oct 1, 2024
3 of 4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Nov 22, 2024
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