docs: add consensus pubkey docs

[atheeshp]

Description

ref: #18141

---

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
• 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.

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

[coderabbitai]

Walkthrough

The changes introduce a new feature for rotating a validator's consensus public key within the staking module of a blockchain system. This feature allows for instant rotation with constraints on frequency and associated fees. It includes data structures for tracking, querying, and handling rotations, and updates the relevant documentation and client commands. The modifications are part of a larger effort to break down a complex pull request into smaller, more manageable pieces for review.

Changes

File Path	Change Summary
x/staking/README.md	Introduces ConsPubkeyRotation feature allowing instant rotation of a validator's consensus public key with constraints on frequency and associated fees. Updates documentation and client commands.
x/staking/keeper/keeper.go	Modifies comments and swaps key format values within the NewKeeper function.

Assessment against linked issues

Objective	Addressed	Explanation
Introduce new required params (#18142)	✅
Msg server changes (#18188)	❓	It is unclear from the summary whether the message server changes have been addressed as no specific file or change related to the message server is mentioned.
ABCI changes (#18236)	❓	The summary does not provide enough detail to determine if ABCI changes have been included.
Tests (#18965)	❓	There is no mention of tests in the summary, so it is unclear if this objective has been addressed.
CLI & tests (#19039)	❓	The summary includes updates to client commands, which may imply CLI changes, but it's unclear if tests related to these are included.
Documentation (docs)	❌	The last item in the linked issues list for documentation is unchecked, indicating that the documentation may not be complete.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

• 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 from git 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.
• 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 to get help, request features, and share feedback.

[facundomedica]

nit: what "in recen unbonding period" means? In the above paragraph it says that only 1 rotation is allow per unbonding window.

[atheeshp]

In the above paragraph it says that only 1 rotation is allow per unbonding window.

Yeah, currently the rotations are allowed once in unbonding period, but this formula applies when we allow more than one rotation in unbonding period of time.

[facundomedica]

+1 to Sam's comments, let's fix those and merge