🔃 Update vesting module to cosmos-sdk v0.50.6

bdeneux commented 6 months ago

📝 Purpose

This PR introduces several updates to the vesting module to align with the cosmos-sdk v0.50.4, while preserving the custom features implemented in our project, such as cliff vesting.

🕶 Changes

The main changes include also :

Unit Tests Improvement: Enhanced the unit tests for all cliff vesting account that was removed in an old PR that update vesting module. I've reintroduce those tests.
CLI command tests: add new unit tests from cosmos for all vesting cli commands
Proto docs generation: Fix proto docs generation when a module directory is set
buf cosmos-sdk proto version: set to 0.54.4
reintroduce add-genesis-account custom command including the --vesting-cliff-time args

Summary by CodeRabbit

New Features
- Introduced a command to add genesis accounts with vesting parameters.
- Added a flag for setting vesting schedule cliff time.
- Enhanced CLI commands to support various vesting account types.
Documentation
- Updated documentation for new vesting account features and commands.
Bug Fixes
- Improved error handling and validation for vesting accounts.
Tests
- Added comprehensive test cases for vesting account creation and validation.
Refactor
- Simplified function signatures and consolidated message assignments for vesting accounts.

coderabbitai[bot] commented 6 months ago

Walkthrough

The changes introduce new functionalities and enhancements to the Axone protocol, particularly focusing on the vesting module. Key updates include adding commands for managing genesis accounts, improving CLI commands for vesting accounts, refining Protobuf definitions, and enhancing test coverage. These modifications aim to streamline account management, improve documentation, and ensure robust testing for various vesting scenarios.

Changes

Files/Paths	Change Summary
`Makefile`, `scripts/protocgen-doc.sh`	Updated `find` command to limit search depth for `.proto` files, affecting documentation generation.
`cmd/axoned/cmd/genaccount.go`, `genaccount_test.go`, `root.go`	Introduced new command for adding genesis accounts with vesting parameters and integrated custom command.
`docs/command/...`	Added new flags and clarified documentation for vesting account creation commands.
`proto/...`	Modified Protobuf definitions, updated dependencies, and adjusted documentation paths.
`x/vesting/...`	Enhanced vesting module functionalities, added error handling, refactored account creation logic, and improved test coverage.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant CLI
    participant AxoneNode
    participant VestingModule

    User->>CLI: Execute add-genesis-account command
    CLI->>AxoneNode: Parse and validate command
    AxoneNode->>VestingModule: Add genesis account with vesting parameters
    VestingModule-->>AxoneNode: Return success/failure
    AxoneNode-->>CLI: Generate response
    CLI-->>User: Display result

Poem

In the realm of code so vast and wide,
New commands and tests now reside,
Vesting accounts with a cliff so steep,
Ensuring tokens safely sleep.
Protobufs and docs refined,
A smoother path, so well-defined.
Hooray for changes, big and small,
Axone's future standing tall! 🚀🐇

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 .` - `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 as 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. 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. - 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://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 6 months ago

Codecov Report

Attention: Patch coverage is 47.65957% with 123 lines in your changes missing coverage. Please review.

@@            Coverage Diff             @@
##             main     #634      +/-   ##
==========================================
- Coverage   53.25%   51.98%   -1.28%     
==========================================
  Files          74       75       +1     
  Lines        3132     2824     -308     
==========================================
- Hits         1668     1468     -200     
+ Misses       1367     1260     -107     
+ Partials       97       96       -1

Files	Coverage Δ
x/vesting/types/msgs.go	`0.00% <ø> (ø)`
x/vesting/types/period.go	`0.00% <ø> (ø)`
x/vesting/types/codec.go	`0.00% <0.00%> (ø)`
x/vesting/client/cli/tx.go	`68.49% <66.66%> (ø)`
x/vesting/module.go	`11.42% <30.76%> (+11.42%)`	:arrow_up:
x/vesting/types/vesting_account.go	`84.86% <72.22%> (+30.61%)`	:arrow_up:
x/vesting/msg_server.go	`84.14% <78.57%> (+14.30%)`	:arrow_up:
x/vesting/types/genaccounts.go	`0.00% <0.00%> (ø)`

... and 66 files with indirect coverage changes

axone-protocol / axoned