Data Indexing

[ljuliandicarlo]

Add guide for Rollkit users to deploy indexing solutions for rollups.

Summary by CodeRabbit

• New Features
  • Introduced a section in the data indexing guide detailing on-chain data indexing and its significance for developers.
  • Highlighted Ormi Labs' offerings, including Subgraph hosting, SQL engine, and custom APIs.
  • Announced an upcoming feature for deploying custom indexing environments for rollups using Rollkit CLI.
  • Added a form for enterprises to submit tailored solution requirements directly to the Ormi team.
  • Included links to additional resources related to Ormi Labs and its services.

[coderabbitai]

Walkthrough

A new section has been added to guides/dataindexing.md, detailing on-chain data indexing and its role in facilitating efficient data retrieval from rollups. It outlines Ormi Labs' offerings, including Subgraph hosting and custom APIs, and introduces the upcoming Rollkit CLI feature for custom indexing environments. The document encourages enterprises to communicate their needs directly to the Ormi team and provides relevant resource links.

Changes

Files	Change Summary
guides/dataindexing.md	Added a section on on-chain data indexing, Ormi Labs' services, and upcoming features.

Poem

In the land of data bright,
Where rollups dance in moonlight,
Ormi's tools will help us find,
The bits and bytes that once were blind.
Hooray for indexing, so neat and grand,
A rabbit's cheer for a helping hand! 🐰✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

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

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)

guides/dataindexing.md (2)

5-5: Consider Conciseness for Upcoming Features.

The sentence about upcoming features could be more concise. Consider rephrasing to improve readability.

Apply this diff for a more concise phrasing:

- Coming soon, Ormi will provide the ability to deploy custom indexing environments for your rollup via the Rollkit CLI, eliminating the need to directly request network support from data providers.
+ Ormi will soon enable deploying custom indexing environments for your rollup via the Rollkit CLI, removing the need to request network support from data providers.

---

7-7: Consider Rephrasing for Conciseness.

The phrase "In the meantime" might be wordy. Consider a shorter alternative for clarity.

Apply this diff for improved conciseness:

- In the meantime, the Ormi team is working with rollups on an ad hoc basis to build these environments.
+ Currently, the Ormi team is collaborating with rollups on an ad hoc basis to build these environments.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8050a80 and c5c4229.

Files selected for processing (1)

• guides/dataindexing.md (1 hunks)

Additional context used

LanguageTool

guides/dataindexing.md

[style] ~6-~6: ‘In the meantime’ might be wordy. Consider a shorter alternative.
Context: ...t network support from data providers. In the meantime, the Ormi team is working with rollups ...

(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)

Additional comments not posted (2)

guides/dataindexing.md (2)

1-3: Clear Introduction.

The introduction effectively communicates the importance of on-chain data indexing.

---

9-12: Effective Call to Action and Resource Links.

The section effectively guides enterprises to communicate their needs and provides useful resource links.