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

chore: fix changelog for v21 #3052

Merged
merged 1 commit into from
Oct 28, 2024
Merged

chore: fix changelog for v21 #3052

merged 1 commit into from
Oct 28, 2024

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Oct 28, 2024

Description

Add v21 in changelog (to be pushed in release branch as well)

Summary by CodeRabbit

  • New Features

    • Introduced support for stateful precompiled contracts.
    • Added a common importable zetacored RPC package.
    • Implemented staking precompiled contract and event emission capabilities.
    • Enhanced support for restricted addresses in Solana and Bitcoin TSS address derivation.
    • Enabled Bitcoin inscription support on testnet.
  • Bug Fixes

    • Resolved issues with voting on discarded keygen ballots and outbound tracker confirmations on EVM chains.
    • Fixed various operational and compatibility issues across components.
  • Refactor

    • Improved code structure and readability, including lint error fixes and message handling updates.
  • Tests

    • Added end-to-end tests for stateful precompiled contracts and updated existing test cases.

Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

📝 Walkthrough

Walkthrough

The pull request introduces version v21.0.0 in the changelog, detailing numerous enhancements, refactors, tests, and fixes. Key features include support for stateful precompiled contracts, a new RPC package, and a staking precompiled contract. Refactoring efforts address lint errors, modify functions to accept new parameters, and improve the structure of messages related to chain information. Testing has been expanded with end-to-end tests for stateful precompiled contracts, while various fixes enhance functionality and resolve issues in the system.

Changes

File Change Summary
changelog.md Added new version entry ## v21.0.0 with features, refactors, tests, and fixes.
Features: support for stateful precompiled contracts, zetacored RPC package, staking precompile,
restricted addresses in Solana, event emission from staking precompile, Bitcoin TSS integration.
Refactors: lint errors, function parameter updates, liquidity cap for ZRC20s, and message updates.
Tests: added end-to-end tests for stateful precompiled contracts.
Fixes: resolved issues related to keygen voting, outbound tracker, and Solana gateway addresses.

Possibly related PRs

Suggested labels

no-changelog

Suggested reviewers

  • swift1337
  • skosito
  • kingpinXD
  • ws4charlie
  • brewmaster012
  • fbac
  • gartnera

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

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.

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.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (5)
changelog.md (5)

5-6: Consider adding release date.

The version entry should include the release date for better tracking and historical reference.

 ## v21.0.0
+Released: 2024-10-XX

Line range hint 8-25: Standardize feature entry format and add impact descriptions.

Some feature entries lack context about their impact on the system. Consider standardizing the format to include:

  1. What changed
  2. Why it changed
  3. Impact on users/system

Example format for the first entry:

-* [2633](https://github.com/zeta-chain/node/pull/2633) - support for stateful precompiled contracts
+* [2633](https://github.com/zeta-chain/node/pull/2633) - Added support for stateful precompiled contracts to enable persistent state management in precompiled contracts, improving contract functionality and state handling.

Line range hint 27-34: Standardize refactor entry format and ensure consistent punctuation.

The refactor entries have inconsistent punctuation and varying levels of detail.

Example format:

-* [2749](https://github.com/zeta-chain/node/pull/2749) - fix all lint errors from govet
+* [2749](https://github.com/zeta-chain/node/pull/2749) - Fixed all lint errors from govet to improve code quality.

Line range hint 36-45: Add test coverage information.

Test entries should include information about the coverage impact and testing scope.

Example format:

-* [2703](https://github.com/zeta-chain/node/pull/2703) - add e2e tests for stateful precompiled contracts
+* [2703](https://github.com/zeta-chain/node/pull/2703) - Added e2e tests for stateful precompiled contracts, achieving X% coverage for the precompiled contracts functionality.

Line range hint 47-57: Add severity levels to fixes.

Fix entries should indicate the severity level and potential impact of the fix.

Example format:

-* [2674](https://github.com/zeta-chain/node/pull/2674) - allow operators to vote on ballots associated with discarded keygen without affecting the status of the current keygen.
+* [2674](https://github.com/zeta-chain/node/pull/2674) - [High] Fixed keygen voting issue: Allowed operators to vote on ballots associated with discarded keygen without affecting current keygen status, preventing potential voting deadlocks.
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4c8c926 and 70e25e3.

📒 Files selected for processing (1)
  • changelog.md (1 hunks)

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.

3 participants