zeta-chain / docs

Documentation for ZetaChain
https://www.zetachain.com/docs/
MIT License
74 stars 60 forks source link

Upgrade proposals: estimated upgrade time #507

Closed fadeev closed 2 days ago

fadeev commented 1 week ago

Summary by CodeRabbit

vercel[bot] commented 1 week ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 7:29am
coderabbitai[bot] commented 1 week ago

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits Reviewing files that changed from the base of the PR and between 75fca03b2b3839e0811707f0ab3b08e0e745eb1d and ba2b7b22f10b1280b3a022a5fee8020d880d11a1.
📒 Files selected for processing (1) * `src/components/Docs/components/GovUpgradeProposals.tsx` (6 hunks)
 _______________________________________
< Nullus Bugus Maximus. No bug too big. >
 ---------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces a new dependency, Moment.js, to the `package.json` file for date manipulation. In the `GovUpgradeProposals.tsx` component, significant modifications include the renaming of an API constant, the addition of a new constant for fetching blockchain data, and the introduction of a state variable to track the latest block height. A new `useEffect` hook is implemented for fetching this data, along with enhanced error handling. Additionally, a function to calculate estimated upgrade times is added, and the component's rendered output now features a new column for these estimates. ## Changes | File Path | Change Summary | |---------------------------------------------------|----------------------------------------------------------------------------------------------------------------| | `package.json` | Added dependency: `"moment": "^2.30.1"` in `dependencies`. | | `src/components/Docs/components/GovUpgradeProposals.tsx` | - Renamed constant: `API` to `API_PROPOSALS`.
- Added constant: `API_BLOCKS`.
- Added state variable: `latestBlock`.
- Introduced `useEffect` for fetching latest block data.
- Added function: `calculateUpgradeTime` for estimating upgrade time.
- Updated error handling and logging for proposals data.
- Rendered table now includes "Estimated Upgrade Time" column. | ## Possibly related PRs - #396: The changes in `GovUpgradeProposals.tsx` involve updates to API endpoint URLs, which are relevant to the same component where the `moment` library is now utilized for calculating upgrade times.

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): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
fadeev commented 1 week ago

@CharlieMc0 added "Estimated upgrade time" estimated based on 5.5 s block time. Anything else we want to see from Polkachu's table?