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: add v0.47.9 and v0.50.4 release notes to main #19531

Merged
merged 3 commits into from
Feb 25, 2024
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Feb 22, 2024

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced an in-place testnet command for easier testing.
    • Added a check for blocked addresses in the creation of periodic vesting accounts.
  • Improvements

    • Enhanced the population of default values in client context for better user experience.
    • Adjusted mathematical operations to align with CometBFT standards.
  • Bug Fixes

    • Resolved issues with setting HeaderInfo in context.
    • Allowed for empty public keys in signatures, fixing related errors.
    • Corrected the sequence in DefaultProposalHandler.
    • Fixed a bug in GetLastValidators to accurately handle MaxValidators.
    • Addressed a bug where delegations with less than 1 token were not being removed as expected during undelegation or redelegation.
  • Chores

    • Reduced redundant CLI logs for a cleaner user interface.

@julienrbrt julienrbrt requested a review from a team as a code owner February 22, 2024 23:13
Copy link
Contributor

coderabbitai bot commented Feb 22, 2024

Walkthrough

This update brings a mix of enhancements and fixes to the system. It includes the addition of an in-place testnet CLI command for improved testing capabilities, enhancements in default value population within client contexts, and alignment of math operations with CometBFT standards. Bug fixes address issues with header information in contexts, proposal handler sequences, and CLI logging. A significant change is the introduction of a state-breaking adjustment in the staking module affecting delegations with less than 1 token.

Changes

File(s) Change Summary
CHANGELOG.md - New in-place testnet CLI command
- Improved default value population
- Fixed bugs related to HeaderInfo
- Matched math with CometBFT
- Avoided redundant CLI logs
- Added BlockedAddr check
x/staking/CHANGELOG.md - Fixed GetLastValidators bug to handle MaxValidators correctly
- State-breaking change: Delegations with less than 1 token are removed entirely during undelegation or redelegation

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>.
    • Generate unit-tests for this file.
  • 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 from git 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
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.

Review Status

Actionable comments generated: 2

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 871b91c and 34f74da.
Files selected for processing (2)
  • CHANGELOG.md (5 hunks)
  • x/staking/CHANGELOG.md (2 hunks)
Additional comments: 5
CHANGELOG.md (5)
  • 52-57: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-3]

The additions to the changelog under the Improvements section for an unspecified version include links to pull requests for new features or enhancements. It's important to ensure that these entries are placed under the correct version heading and that the descriptions are clear and concise.

  • 52-57: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [2-2]

The Bug Fixes section correctly documents various fixes across different components of the SDK. Each entry is linked to its corresponding pull request, providing traceability. It's crucial that these entries are accurate and that the links are valid.

  • 52-57: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [3-3]

The entries under the Bug Fixes and API Breaking Changes sections are well-documented, with each fix or change linked to its respective pull request. This section helps users understand the impact of the changes and any necessary actions they may need to take.

  • 52-57: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [4-4]

The Deprecated section clearly outlines the features that are being phased out in favor of new implementations. This is crucial for developers to adapt their applications to the latest standards and practices recommended by the SDK.

  • 52-57: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [5-5]

The changelog entries for versions v0.50.4 and v0.47.9 include both new features and bug fixes. It's important to ensure that these entries are under the correct version headings and that the descriptions accurately reflect the changes made. The repetition of the BlockedAddr check in CreatePeriodicVestingAccount under both versions suggests a potential error in documentation or a backport of the feature to an older version. Clarification or correction might be needed here.

Verification successful

The verification process has confirmed that the CHANGELOG.md file exists and contains entries for versions v0.50.4 and v0.47.9. Additionally, it has been verified that there are mentions of the BlockedAddr check in CreatePeriodicVestingAccount under the section related to bug fixes, as well as a mention of adding Amino Msg registration for MsgCreatePeriodicVestingAccount. The repetition of the BlockedAddr check under both versions suggests that this change was indeed documented for both versions, which could indicate either a documentation error or a deliberate backport of the feature to an older version. Given this information, it is recommended to clarify or correct the changelog entries as needed to accurately reflect the changes made in each version.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify if the BlockedAddr check was indeed added in both versions or if this is a documentation error.
# This script assumes the presence of detailed release notes or PR descriptions for verification.
grep -E "BlockedAddr check in CreatePeriodicVestingAccount" CHANGELOG.md

Length of output: 74



Script:

#!/bin/bash
# Check if CHANGELOG.md exists and contains entries for versions v0.50.4 and v0.47.9.
if [ -f CHANGELOG.md ]; then
    echo "CHANGELOG.md exists."
    echo "Searching for versions v0.50.4 and v0.47.9 entries..."
    grep -E "v0.50.4|v0.47.9" CHANGELOG.md
    echo "Searching for mentions of 'BlockedAddr' or 'CreatePeriodicVestingAccount'..."
    grep -E "BlockedAddr|CreatePeriodicVestingAccount" CHANGELOG.md
else
    echo "CHANGELOG.md does not exist."
fi

Length of output: 1012

x/staking/CHANGELOG.md Show resolved Hide resolved
x/staking/CHANGELOG.md Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 34f74da and 0cb01b2.
Files selected for processing (2)
  • CHANGELOG.md (5 hunks)
  • x/staking/CHANGELOG.md (2 hunks)
Files skipped from review as they are similar to previous changes (2)
  • CHANGELOG.md
  • x/staking/CHANGELOG.md

auto-merge was automatically disabled February 24, 2024 13:41

Merge queue setting changed

@julienrbrt julienrbrt added this pull request to the merge queue Feb 25, 2024
Merged via the queue into main with commit 98acef8 Feb 25, 2024
52 of 53 checks passed
@julienrbrt julienrbrt deleted the julien/releases branch February 25, 2024 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants