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.

Sign up for GitHub

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

Jump to bottom

feat: swap out openrpc #308

Merged
merged 1 commit into from
Jan 22, 2024
Merged

feat: swap out openrpc #308

merged 1 commit into from
Jan 22, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jan 22, 2024 •
edited by coderabbitai bot
Loading

Overview

Changes docs to use celestia-da, not celestia-openrpc.

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated references to Celestia Node API and related packages.
    • Added a note on the requirement to run a Celestia light node for deploying Rollkit rollups.

@jcstein jcstein self-assigned this Jan 22, 2024
@jcstein jcstein added the documentation Improvements or additions to documentation label Jan 22, 2024
@jcstein jcstein requested review from MSevey and tuxcanfly January 22, 2024 18:56
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 22, 2024 •
edited
Loading

Walkthrough

The update reflects a shift in the Rollkit framework to accommodate the latest Celestia Node API, necessitating users to run a Celestia light node for data availability when deploying Rollkit-based rollups on Celestia.

Changes

Files Changed Summary of Changes
learn/stack.md Updated references from Celestia Node Gateway API to Celestia Node API; added requirement for running a Celestia light node with Rollkit deployments.

🐇✨
In the realm of code, where data streams flow,
A rabbit tweaked the nodes, to make the rollups grow.
With light nodes a-humming, the updates unfurl,
In the blockchain's burrow, a new chapter swirls.
🌟🌿

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 22, 2024 •
edited
Loading

PR Preview Action v1.4.6
Preview removed because the pull request was closed.
2024-01-22 19:11 UTC

coderabbitai[bot]
coderabbitai bot reviewed Jan 22, 2024
View reviewed changes
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2a1189c and 24ece43.
Files selected for processing (1)
  • learn/stack.md (1 hunks)
Additional comments: 1
learn/stack.md (1)
  • 51-52: The references to the Celestia Node Gateway API and related packages have been updated to the Celestia Node API and the corresponding package, rollkit/celestia-da. Ensure that all hyperlinks are functional and lead to the correct resources.

@jcstein jcstein merged commit 88cb0cf into main Jan 22, 2024
4 checks passed
@jcstein jcstein deleted the jcs/use-celestia-da branch January 22, 2024 19:10
MSevey
MSevey reviewed Jan 22, 2024
View reviewed changes
learn/stack.md
It's using the [Celestia Node Gateway API](https://docs.celestia.org/developers/node-gateway-docs/)
via the [`rollkit/celestia-openrpc`](https://github.com/rollkit/celestia-openrpc) package.
It's using the [Celestia Node API](https://node-rpc-docs.celestia.org)
via the [`rollkit/celestia-da`](https://github.com/rollkit/celestia-da) package.
To deploy a Rollkit rollup on Celestia you also have to [run a Celestia light node](https://docs.celestia.org/developers/node-tutorial/).

Use of other data availability (DA) layers is also supported by Rollkit, and research integrations for Bitcoin, Mock, gRPC are works in progress.
Copy link
Contributor

Choose a reason for hiding this comment

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

can we also add a reference to go-da here?

Suggested change
Use of other data availability (DA) layers is also supported by Rollkit, and research integrations for Bitcoin, Mock, gRPC are works in progress.
Use of other data availability (DA) layers is also supported by Rollkit, and research integrations for Bitcoin, Mock, gRPC are works in progress. New DA layer integrations can be added by using the [go-da](https://github.com/rollkit/go-da) interface.

Copy link
Member Author

Choose a reason for hiding this comment

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

yes feel free to open PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MSevey MSevey MSevey left review comments

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@tuxcanfly tuxcanfly tuxcanfly approved these changes

Assignees

@jcstein jcstein

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jcstein @tuxcanfly @MSevey