docs(x/auth): vesting

[julienrbrt]

Description

Removes changelog mention, as this feature has been dropped: #17810 (comment)

---

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 support for broadcasting unordered and multiple transactions.
  • Enhanced transaction validation efficiency, reducing gas consumption.

• Bug Fixes

  • Removed ability to specify a start time for continuous vesting accounts.

• Documentation

  • Updated documentation to reflect the deprecation of vesting accounts in favor of lockup accounts within the x/accounts module.
  • Clarified backward compatibility requirements for existing chains using vesting accounts.

[coderabbitai]

Walkthrough

Walkthrough

The pull request introduces significant changes to the Cosmos SDK, particularly affecting the x/auth and x/accounts modules. The functionality for creating new vesting accounts has been removed, directing users to utilize lockup accounts or implement vesting accounts through the x/accounts module. Additionally, the management of account numbers has been updated, with the AccountNumber now serving as a global identifier. These changes streamline account management and necessitate user adaptation for existing implementations.

Changes

File	Change Summary
x/auth/UPGRADING.md	Removed vesting account messages and CLIs, added use of x/accounts for vesting account management, modified AccountNumber usage.
x/auth/CHANGELOG.md	Introduced unordered transaction broadcasting, added support for multiple transactions, removed start time specification for continuous vesting accounts, improved transaction validation efficiency.
x/auth/README.md	Updated documentation to indicate deprecation of vesting accounts in favor of x/accounts, clarified backward compatibility for existing chains.
x/auth/vesting/README.md	Documented deprecation of the x/auth/vesting module, updated versioning information, maintained backward compatibility notes.

Possibly related PRs

• fix(x/accounts/lockup): prevent double withdraw #21619: The changes in the x/accounts module regarding the management of account numbers and the removal of vesting accounts are directly related to the modifications made in the WithdrawUnlockedCoins method, which operates within the same module.

Suggested labels

C:x/accounts, backport/v0.52.x

Tip

OpenAI O1 model for chat

• We have deployed OpenAI's latest O1 model for chat.
• OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
• Please share any feedback with us in the discussions post.

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7392525 and 03e79ec.

Files selected for processing (4)

• UPGRADING.md (1 hunks)
• x/auth/CHANGELOG.md (1 hunks)
• x/auth/README.md (1 hunks)
• x/auth/vesting/README.md (1 hunks)

Files skipped from review due to trivial changes (1)

• x/auth/vesting/README.md

Additional context used

Path-based instructions (3)

x/auth/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

x/auth/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

UPGRADING.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

LanguageTool

UPGRADING.md

[uncategorized] ~444-~444: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sting vesting accounts will keep working but no new vesting accounts can be created....

(COMMA_COMPOUND_SENTENCE_2)

Additional comments not posted (8)

x/auth/CHANGELOG.md (1)

62-62: Documentation looks good!

The documentation accurately describes the removal of vesting account creation when the chain is running and provides a helpful reference to the accounts module for creating vesting accounts on a running chain. This change is consistent with the AI-generated summary.

x/auth/README.md (1)

141-145: LGTM!

The warning message is clear and informative. It effectively communicates the deprecation of vesting accounts, the migration to the x/accounts module, and the backward compatibility concern for existing chains.

UPGRADING.md (6)

442-446: Breaking change in x/auth module: Vesting accounts

The x/auth module has removed support for creating new vesting accounts through messages and CLI commands. Existing vesting accounts will continue to function, but new ones cannot be created.

As an alternative, consider using lockup accounts from the x/accounts module or implementing a custom vesting account within x/accounts.

Tools

LanguageTool

[uncategorized] ~444-~444: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sting vesting accounts will keep working but no new vesting accounts can be created....

(COMMA_COMPOUND_SENTENCE_2)

---

Line range hint 448-450: Critical data migration: AccountNumber

When upgrading to v0.52.x, it's crucial to migrate the AccountNumber from the x/auth module to the x/accounts module. The x/accounts module's AccountNumber will be used as the global account number moving forward.

To perform this migration, use the MigrateAccountNumber function from the auth keeper in your upgrade handler:

import authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper" 
...
err := authkeeper.MigrateAccountNumberUnsafe(ctx, &app.AuthKeeper)
if err != nil {
	return nil, err
}

Tools

LanguageTool

[grammar] ~439-~439: The singular determiner ‘this’ may not agree with the plural noun ‘changes’. Did you mean “these”?
Context: ...Many functions have been removed due to this changes as the API can be smaller thank...

(THIS_NNS)

---

[uncategorized] ~444-~444: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sting vesting accounts will keep working but no new vesting accounts can be created....

(COMMA_COMPOUND_SENTENCE_2)

---

Line range hint 452-452: Removed module: x/crisis

The x/crisis module has been removed from the Cosmos SDK as it was no longer supported or functional.

If your application was not using the x/crisis module, no action is required. However, if you were using it, you'll need to remove any references to it in your codebase.

Tools

LanguageTool

[grammar] ~439-~439: The singular determiner ‘this’ may not agree with the plural noun ‘changes’. Did you mean “these”?
Context: ...Many functions have been removed due to this changes as the API can be smaller thank...

(THIS_NNS)

---

[uncategorized] ~444-~444: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sting vesting accounts will keep working but no new vesting accounts can be created....

(COMMA_COMPOUND_SENTENCE_2)

---

Line range hint 454-454: Required module for x/distribution users: x/protocolpool

If your chain is using the x/distribution module, you must add the new x/protocolpool module when upgrading to v0.52.x.

Please refer to the x/protocolpool module's documentation for more information on how to integrate it into your chain.

Tools

LanguageTool

[grammar] ~439-~439: The singular determiner ‘this’ may not agree with the plural noun ‘changes’. Did you mean “these”?
Context: ...Many functions have been removed due to this changes as the API can be smaller thank...

(THIS_NNS)

---

[uncategorized] ~444-~444: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sting vesting accounts will keep working but no new vesting accounts can be created....

(COMMA_COMPOUND_SENTENCE_2)

---

Line range hint 456-462: Update Gov v1beta1 proposal handler signature

The x/gov module's v1beta1 proposal handler now takes a context.Context instead of sdk.Context. This change was made to ensure compatibility of legacy proposals with server/v2.

If you are migrating to server/v2, update your proposal handler to take a context.Context and use services within the handler.

For chains using baseapp, you can continue using sdk.Context by unwrapping it from the context.Context in your proposal handler.

Tools

LanguageTool

[grammar] ~439-~439: The singular determiner ‘this’ may not agree with the plural noun ‘changes’. Did you mean “these”?
Context: ...Many functions have been removed due to this changes as the API can be smaller thank...

(THIS_NNS)

---

[uncategorized] ~444-~444: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sting vesting accounts will keep working but no new vesting accounts can be created....

(COMMA_COMPOUND_SENTENCE_2)

---

Line range hint 464-464: New module: x/protocolpool

The x/protocolpool module is a new addition in v0.52.x, designed to handle community pool funds.

When upgrading to v0.52.x, you must add the x/protocolpool module's store to your chain's store configuration.

For more information on integrating the x/protocolpool module and adding its store, please refer to the module's documentation.

Tools

LanguageTool

[grammar] ~439-~439: The singular determiner ‘this’ may not agree with the plural noun ‘changes’. Did you mean “these”?
Context: ...Many functions have been removed due to this changes as the API can be smaller thank...

(THIS_NNS)

---

[uncategorized] ~444-~444: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...sting vesting accounts will keep working but no new vesting accounts can be created....

(COMMA_COMPOUND_SENTENCE_2)

---

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
• Mastodon
• Reddit
• LinkedIn

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.