chore: sync changelogs #22992

julienrbrt · 2024-12-18T20:46:59Z

Description

Follow-up from rcs + prepare core v1 final.

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, you can find examples of the prefixes below:
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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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 new functionalities including nested message simulation, hex key import support, and enhanced server information retrieval.
- Added off-chain signing and verification, governance proposal support, and improved transaction factory features.
- Implemented epoched minting and new query capabilities for NFTs.
Improvements
- Upgraded RocksDB libraries and simplified testing frameworks.
- Enhanced error handling across multiple modules.
Bug Fixes
- Resolved data race issues, improved transaction byte size calculations, and fixed issues with unmarshalling in transactions.
API Breaking Changes
- Significant alterations to method signatures and removal of deprecated features across various modules.
Documentation
- Updated changelogs for clarity and organization, reflecting the latest changes and version updates.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (31)

x/protocolpool/CHANGELOG.md (1)
28-30: Enhance the changelog entry with more details

The changelog entry for introducing a new module should:

Be categorized under appropriate sections (Features, API Breaking Changes, etc.)

Include the PR reference (feat(x/protocolpool,x/distribution)!: remove dependency + fix continuous fund bug #20790) for the BeginBlock addition

Provide more details about the module's purpose and functionality

Example structure:
## [v0.2.0-rc.1](https://github.com/cosmos/cosmos-sdk/releases/tag/x/protocolpool/v0.2.0-rc.1) - 2024-12-18

### Features
* [#20790] Introduce the `x/protocolpool` module with its own BeginBlock
* <Add brief description of module's purpose>

### API Breaking Changes
* <List any breaking changes if applicable>
x/consensus/CHANGELOG.md (1)
Line range hint 37-40: Maintain consistent PR reference formatting

Please maintain consistency in PR references:

Add module prefix (x/consensus) to the second feature entry

Keep consistent format for PR references (include parentheses for module name)

Example:
* (x/consensus) [#19483](https://github.com/cosmos/cosmos-sdk/pull/19483) Add consensus messages registration to consensus module.
- * [#20615](https://github.com/cosmos/cosmos-sdk/pull/20615) Add consensus messages to add cometinfo to consensus modules
+ * (x/consensus) [#20615](https://github.com/cosmos/cosmos-sdk/pull/20615) Add consensus messages to add cometinfo to consensus modules
x/circuit/CHANGELOG.md (1)
37-38: Add module prefix to API Breaking Changes entry

Please add the module prefix for consistency with other entries:
- * [#19041](https://github.com/cosmos/cosmos-sdk/pull/19041) `appmodule.Environment` is received on the Keeper to get access to different application services
+ * (x/circuit) [#19041](https://github.com/cosmos/cosmos-sdk/pull/19041) `appmodule.Environment` is received on the Keeper to get access to different application services
x/nft/CHANGELOG.md (1)

34-35: Add consistent line spacing between version header and sections

Add a single blank line between the version header and the first section for consistency with other entries in the changelog.

x/mint/CHANGELOG.md (2)

28-29: Add consistent line spacing between version header and sections

Add a single blank line between the version header and the first section for consistency with other entries in the changelog.

Line range hint 38-42: Clarify the impact of API breaking changes

The deprecation notice should explicitly mention the migration path for existing users. Consider adding a brief example or more detailed migration instructions.

🧰 Tools

🪛 LanguageTool

[style] ~37-~37: Consider a shorter alternative to avoid wordiness.
Context: ...per.DefaultMintFnwrapper must be used in order to continue using it inNewAppModule`. Th...

(IN_ORDER_TO_PREMIUM)

x/group/CHANGELOG.md (3)

28-29: Add consistent line spacing between version header and sections

Add a single blank line between the version header and the first section for consistency with other entries in the changelog.

Line range hint 33-34: Fix PR reference formatting

The PR reference [18286] is missing the # prefix. Update to [#18286] for consistency with other entries.

Line range hint 33-34: Enhance clarity of the improvement entry

The entry "Move prefix store creation down after error checks" could be more descriptive about the impact and benefits of this change.

x/slashing/CHANGELOG.md (2)

Line range hint 34-34: Fix grammatical error

Change "NewAppModule now takes in a core/comet.Service an argument" to "NewAppModule now takes in a core/comet.Service as an argument"

51-51: Add newline at end of file

Add a newline character at the end of the file to comply with markdown standards.

🧰 Tools

🪛 Markdownlint (0.37.0)

51-51: null
Files should end with a single newline character

(MD047, single-trailing-newline)

x/evidence/CHANGELOG.md (1)

34-34: Fix grammatical error

Change "NewAppModule now takes in a core/comet.Service an argument" to "NewAppModule now takes in a core/comet.Service as an argument"

x/authz/CHANGELOG.md (1)

42-42: Fix typo in word "address"

Change "adress codecs" to "address codecs"

x/bank/CHANGELOG.md (1)

28-29: Add release status information

Consider adding a note indicating whether this is a pre-release or release candidate version, as this helps users understand the stability expectations.
x/feegrant/CHANGELOG.md (2)
36-36: Fix grammatical issue in feature description

Add a comma after "file" for better readability:
-The `x/feegrant` module is extracted to have a separate go.mod file which allows it to be a standalone module.
+The `x/feegrant` module is extracted to have a separate go.mod file, which allows it to be a standalone module.
🧰 Tools

🪛 LanguageTool

[uncategorized] ~36-~36: Possible missing comma found.
Context: ... is extracted to have a separate go.mod file which allows it to be a standalone modu...

(AI_HYDRA_LEO_MISSING_COMMA)

41-42: Improve formatting consistency in API Breaking Changes

Consider using consistent bullet point indentation for better readability. The sub-bullets should align with the text above.
x/upgrade/CHANGELOG.md (2)

Line range hint 39-39: Enhance state machine breaking change description

The state machine breaking change description should include more context about the impact of moving app version storage to baseapp's ParamStore. Consider adding:

Migration implications

Any required actions from users

28-28: Ensure consistent changelog formatting across modules

While all changelogs follow the same template, consider standardizing:

Section ordering (e.g., Features, Improvements, Bug Fixes, API Breaking Changes)

Bullet point indentation

Description style and length

Also applies to: 28-28, 28-28
x/auth/CHANGELOG.md (2)
26-26: Fix grammatical error: "it's" should be "its"

The possessive form "its" should be used instead of the contraction "it's" (which means "it is").
-While x/auth has not been extracted from the Cosmos SDK, it's changelog is maintained here for consistency with the rest of the modules.
+While x/auth has not been extracted from the Cosmos SDK, its changelog is maintained here for consistency with the rest of the modules.
🧰 Tools

🪛 LanguageTool

[grammar] ~26-~26: Did you mean to use the possessive pronoun “its”?
Context: ...not been extracted from the Cosmos SDK, it's changelog is maintained here for consis...

(IT_S_ITS)

67-67: Remove orphaned line number

There appears to be an orphaned line number in the middle of the changelog which should be removed for better readability.
x/distribution/CHANGELOG.md (2)

28-28: Standardize version number format

The version number format should be consistent across all modules. Consider aligning with the format used in other modules.

Line range hint 71-71: Remove reverted change note

The strikethrough text about the PoolKeeper argument should be removed since it was reverted in PR #20790.

x/gov/CHANGELOG.md (1)

Line range hint 31-38: Consider consistent formatting in Features section

Each feature entry should start with a verb (Add, Introduce, etc.) for consistency.

x/staking/CHANGELOG.md (1)

30-32: Enhance metadata feature description

The metadata feature description could be more detailed about what information can be stored and its purpose.

core/CHANGELOG.md (1)

39-42: Consider adding explicit version information

While noting that v1.0.0 is identical to v1.0.0-alpha.6 is correct, consider adding:

The release date

A brief summary of key changes from the alpha version
CHANGELOG.md (3)
238-238: Fix inconsistent line references

There appear to be duplicate line numbers (238 and 1208) in the changelog entries. This could cause confusion when referencing specific changes.

Consider fixing the line numbering to ensure each entry has a unique line reference.

Also applies to: 1208-1208

1156-1160: Improve formatting consistency in module entries

The module entries in these lines have inconsistent bullet point formatting:
- * (x/mint) [#12363](https://github.com/cosmos/cosmos-sdk/pull/12363) Migrate `x/mint` to self-managed parameters and deprecate its usage of `x/params`.
- * (x/distribution) [#12434](https://github.com/cosmos/cosmos-sdk/pull/12434) Migrate `x/distribution` to self-managed parameters and deprecate its usage of `x/params`.
- * (x/crisis) [#12445](https://github.com/cosmos/cosmos-sdk/pull/12445) Migrate `x/crisis` to self-managed parameters and deprecate its usage of `x/params`.
- * (x/gov) [#12631](https://github.com/cosmos/cosmos-sdk/pull/12631) Migrate `x/gov` to self-managed parameters and deprecate its usage of `x/params`.
Consider standardizing the bullet point format and removing the line numbers between entries for better readability.

Line range hint 1-50: Add version comparison table

For better usability, consider adding a version comparison table at the top of the changelog that summarizes major changes between versions. This would help users quickly identify which version contains the features they need.

Example format:
| Version | Major Features | Breaking Changes | Minimum Go Version |
|---------|---------------|------------------|-------------------|
| v0.47.0 | Feature A, B  | Change X, Y      | 1.18             |
| v0.46.0 | Feature C, D  | Change Z         | 1.17             |
x/params/CHANGELOG.md (1)

27-27: Consider removing empty Unreleased section

The Unreleased section is empty. Consider removing it if there are no unreleased changes to track.
x/accounts/defaults/base/CHANGELOG.md (2)
28-28: Fix typo in changelog message

There's a typo in the changelog message: "Inital" should be "Initial".
-Inital release of the `x/accounts/defaults/base` module.
+Initial release of the `x/accounts/defaults/base` module.
🧰 Tools

🪛 Markdownlint (0.37.0)

28-28: null
Files should end with a single newline character

(MD047, single-trailing-newline)

28-28: Add newline at end of file

Add a newline character at the end of the file to comply with markdown formatting standards.

🧰 Tools

🪛 Markdownlint (0.37.0)

28-28: null
Files should end with a single newline character

(MD047, single-trailing-newline)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 96cfd52 and 1b34c65.

📒 Files selected for processing (27)

CHANGELOG.md (7 hunks)
client/v2/CHANGELOG.md (1 hunks)
core/CHANGELOG.md (1 hunks)
tools/benchmark/CHANGELOG.md (1 hunks)
tools/confix/CHANGELOG.md (1 hunks)
x/accounts/CHANGELOG.md (1 hunks)
x/accounts/defaults/base/CHANGELOG.md (1 hunks)
x/accounts/defaults/lockup/CHANGELOG.md (1 hunks)
x/accounts/defaults/multisig/CHANGELOG.md (1 hunks)
x/auth/CHANGELOG.md (2 hunks)
x/authz/CHANGELOG.md (2 hunks)
x/bank/CHANGELOG.md (1 hunks)
x/circuit/CHANGELOG.md (1 hunks)
x/consensus/CHANGELOG.md (1 hunks)
x/distribution/CHANGELOG.md (1 hunks)
x/epochs/CHANGELOG.md (1 hunks)
x/evidence/CHANGELOG.md (1 hunks)
x/feegrant/CHANGELOG.md (1 hunks)
x/gov/CHANGELOG.md (1 hunks)
x/group/CHANGELOG.md (1 hunks)
x/mint/CHANGELOG.md (1 hunks)
x/nft/CHANGELOG.md (1 hunks)
x/params/CHANGELOG.md (1 hunks)
x/protocolpool/CHANGELOG.md (1 hunks)
x/slashing/CHANGELOG.md (2 hunks)
x/staking/CHANGELOG.md (2 hunks)
x/upgrade/CHANGELOG.md (1 hunks)

✅ Files skipped from review due to trivial changes (5)

x/accounts/defaults/lockup/CHANGELOG.md
x/accounts/defaults/multisig/CHANGELOG.md
x/epochs/CHANGELOG.md
tools/benchmark/CHANGELOG.md
tools/confix/CHANGELOG.md

🧰 Additional context used

📓 Path-based instructions (22)

x/protocolpool/CHANGELOG.md (1)