celestiaorg / celestia-app

Celestia consensus node
https://celestiaorg.github.io/celestia-app/
Apache License 2.0
345 stars 292 forks source link

docs: remaining docs from versioned gas scheduler variables #3914

Closed ninabarbakadze closed 1 month ago

ninabarbakadze commented 1 month ago

Overview

github-actions[bot] commented 1 month ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://celestiaorg.github.io/celestia-app/pr-preview/pr-3914/ on branch gh-pages at 2024-09-26 13:27 UTC

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough This pull request introduces new documentation entries for "AnteHandler v3" and "Parameters v3" in the `SUMMARY.md`, `ante_handler.md`, and `parameters.md` files. A new file `ante_handler_v3.md` is created to define the AnteHandler for app version 3, detailing the criteria for transaction processing and associated side effects. ## Changes | Files | Change Summary | |-----------------------------------------|---------------------------------------------------------------------------------------------------| | `specs/src/SUMMARY.md`, `specs/src/ante_handler.md`, `specs/src/parameters.md` | Added new entries for `[AnteHandler v3](./ante_handler_v3.md)` and `[Parameters v3](./parameters_v3.md)`, expanding the documentation for both specifications. | | `specs/src/ante_handler_v3.md` | Introduced AnteHandler for app version 3, detailing transaction processing criteria and side effects. | ## Assessment against linked issues | Objective | Addressed | Explanation | |------------------------------------------------------------------|-----------|-----------------------------------------------| | Add a params v3 page to the specs ( #3762 ) | ✅ | | | Mark `blob.GasPerBlobByte` and `auth.TxSizeCostPerByte` as non-governance modifiable on that page ( #3762 ) | ❓ | The specific marking of parameters as non-governance modifiable is not detailed in the PR. | ## Possibly related PRs - #3661: Updates to the `SUMMARY.md` file, which is directly related to the addition of the "AnteHandler v3" and "Parameters v3" entries. - #3864: Updates to the `specs/src/parameters_v2.md` file, relevant to the documentation of parameters. ## Suggested labels `WS: V2 ✌️`, `external` ## Suggested reviewers - cmwaters - rootulp - evan-forbes

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. 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 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
cmwaters commented 1 month ago

Shouldn't we hold out on this until we know if there will be a tx size capping antehandler in v3?

ninabarbakadze commented 1 month ago

Shouldn't we hold out on this until we know if there will be a tx size capping antehandler in v3?

We changed some gas scheduler variable related stuff which is used in ante handler so I updated that and NetworkMinGasPrice reference as well.

tx size capping antehandler pr already adds another rule so we can just merge this and then add the tx size capping section if we do end up pushing it out.