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

docs(specs): block rules #3168

Merged
merged 2 commits into from
Mar 8, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Mar 7, 2024

Closes #3165

While I was working on this, I noticed that the transaction validity rules section was incorrect because it failed to differentiate the rules for app version v1 and v2. Can extract that to a stand-alone PR if reviewers prefer that.

@rootulp rootulp self-assigned this Mar 7, 2024
@rootulp rootulp changed the title specs: block rules docs(specs): block rules Mar 7, 2024
@rootulp rootulp marked this pull request as ready for review March 7, 2024 03:59
Copy link
Contributor

coderabbitai bot commented Mar 7, 2024

Walkthrough

Walkthrough

The update organizes Celestia's block validity rules into multiple groups, specifically introducing Block Rules and Transaction Validity Rules for varying application versions. It outlines the requirements for transaction ordering and decoding, and details the rules applicable to different transaction types, ensuring clarity and structure within the specifications.

Changes

Files Changed Summary of Changes
specs/.../block_validity_rules.md Introduced multiple groups for Celestia specific validity rules, detailing Block Rules and Transaction Validity Rules for application versions, and specified requirements for transaction ordering and decoding, including rules for different transaction types.

Assessment against linked issues

Objective Addressed Explanation
[#3165: all non-PFB transactions must be ordered before PFB transactions]

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 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.

Copy link
Collaborator

@staheri14 staheri14 left a comment

Choose a reason for hiding this comment

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

Nice 👍

@rootulp rootulp merged commit a93bb62 into celestiaorg:main Mar 8, 2024
34 of 36 checks passed
@rootulp rootulp deleted the rp/spec-block-validity-rule branch March 8, 2024 03:30
ninabarbakadze pushed a commit to ninabarbakadze/celestia-app that referenced this pull request Apr 2, 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.

specs: all non-PFB transactions must be ordered before PFB transactions
3 participants