search

osmosis-labs / cosmos-sdk

:chains: A Framework for Building High Value Public Blockchains :sparkles:
https://cosmos.network/
Apache License 2.0
14 stars 33 forks source link

fix: less time intensive slashing migration #580

Closed czarcas7ic closed 6 months ago

czarcas7ic commented 6 months ago

Description

Closes: #XXXX

Updates slashing migration logic to:

  1. Reset all validators slashing window to 0 instead of porting over their current state
  2. Delete 2000 records per block until completion instead of all at once

Testing

I did a broad test with the in-place-testnet and all seemed well. When we do a more thorough upgrade test with multiple validators, we should bring a validator down and ensure the counter incs as expected.

Just b/c it took me a little to figure this out let me write it here:

You get the validator address like: osmosisd tendermint show-validator

And then get signing info like: osmosisd q slashing signing-info '{"@type":"/cosmos.crypto.ed25519.PubKey","key":"kY2Q8mLJkMgK9aFfZlvfllUiiP0D+h7HC+3hH87Qosk="}'

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The changes involve introducing a mechanism to handle deprecated missed block bit arrays in the slashing module, aiming to improve performance and maintainability. A global variable sets a pruning limit per block, and a new function facilitates the deletion of deprecated entries. The migration script updates key prefixes and ensures backward compatibility without causing chain downtime during upgrades. These modifications signify an effort to optimize data storage and access patterns within the blockchain framework.

Changes

Files Change Summaries
x/slashing/abci.go - Introduced deprecatedBitArrayPruneLimitPerBlock.
- Added deletion logic for deprecated bit arrays in BeginBlocker.
x/slashing/keeper/keeper.go - Added v4 import.
- Added DeleteDeprecatedValidatorMissedBlockBitArray function.
x/slashing/migrations/v4/keys.go
x/slashing/migrations/v4/migrate.go
x/slashing/migrations/v4/migrate_test.go		 - Updated and introduced key prefixes.
- Adjusted migration logic for deprecated bit arrays, including handling of empty slices and pruning indicators.
- Modified test logic to align with the new key usage and simplified checks for missed blocks.
x/slashing/types/keys.go - Modified and updated key prefixes.
- Introduced IsPruningKey and TrueByteValue.

🐇✨
In the blockchain's heart, where bits arrayed,
A rabbit hopped, pruning paths it made.
With keys and codes, it danced and swayed,
Through deprecated fields, a new trail laid.
"To optimize!" it cheerfully brayed,
Leaving bytes lighter, in the shade.
🌿🚀

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests 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 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 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](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.