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: migrate and cleanup delegations #216

Merged
merged 12 commits into from
Dec 23, 2024
Merged

Conversation

mbreithecker
Copy link
Member

@mbreithecker mbreithecker commented Dec 23, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced upgrade handling functionality with additional parameters for improved integration during upgrades.
    • New migration logic for protocol stakers, including handling of undelegation and withdrawal of pending commissions.
    • Introduction of example validator configurations for Kaon and mainnet.
  • Bug Fixes

    • Streamlined account asset calculations, focusing on clearer reporting of outstanding rewards and delegation amounts.
  • Documentation

    • Updated README with instructions for validators on linking protocol and consensus validators prior to upgrade.
  • Chores

    • Removed delegation-related commands and API entries, simplifying the command structure and documentation.
    • Eliminated unused delegation functions and interfaces, refining the codebase for better maintainability.

# Conflicts:
#	x/delegation/keeper/msg_server_redelegate_test.go
#	x/delegation/keeper/msg_server_undelegate_test.go
# Conflicts:
#	docs/static/openapi.yml
#	x/delegation/keeper/msg_server_redelegate.go
#	x/delegation/keeper/msg_server_redelegate_test.go
#	x/delegation/keeper/msg_server_undelegate_test.go
#	x/delegation/types/expected_keepers.go
#	x/pool/keeper/msg_server_disable_pool_test.go
#	x/query/keeper/grpc_account_redelegation_test.go
#	x/stakers/types/keys.go
Copy link

coderabbitai bot commented Dec 23, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a comprehensive refactoring of the delegation module in the KYVE Network, effectively removing delegation-specific functionality and integrating delegation logic into other existing modules. The changes involve removing multiple files, modifying keeper structures, and updating the upgrade process to handle protocol-to-consensus validator linking. The upgrade aims to simplify the delegation mechanism and transition to a more integrated staking approach.

Changes

File/Group Change Summary
app/app.go Updated upgrade handler to include additional keepers
app/upgrades/v2_0/upgrade.go Enhanced upgrade process with new migration function for protocol stakers
proto/kyve/delegation/* Removed delegation-related proto definitions
x/delegation/* Completely removed delegation module implementation
x/query/keeper/ Removed delegation-specific query implementations
util/expected_keepers.go Added new methods to StakingKeeper interface

Sequence Diagram

sequenceDiagram
    participant Validator
    participant UpgradeHandler
    participant StakingKeeper
    participant BankKeeper

    Validator->>UpgradeHandler: Initiate Upgrade
    UpgradeHandler->>StakingKeeper: Migrate Protocol Stakers
    StakingKeeper->>BankKeeper: Transfer Pending Commissions
    StakingKeeper->>StakingKeeper: Update Validator Parameters
    UpgradeHandler-->>Validator: Upgrade Complete
Loading

Possibly related PRs

Suggested Reviewers

  • troykessler

Poem

🐰 Delegation's dance is done,
Stakers now move as one!
Keepers merge, protocols align,
A blockchain ballet, simply divine!
Upgrade complete, the rabbit cheers! 🎉

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

CodeRabbit Configuration 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 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 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.

@mbreithecker mbreithecker marked this pull request as ready for review December 23, 2024 16:23
@mbreithecker mbreithecker merged commit af2eb6d into main Dec 23, 2024
4 checks passed
@mbreithecker mbreithecker deleted the mbreithecker/migration branch December 23, 2024 16:34
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.

2 participants