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

feat(client/v2): add support for pubkey #19039

Merged
merged 12 commits into from
Jan 12, 2024
Merged

feat(client/v2): add support for pubkey #19039

merged 12 commits into from
Jan 12, 2024

Conversation

atheeshp
Copy link
Contributor

@atheeshp atheeshp commented Jan 12, 2024

Description

This PR adds support rotate-cons-pubkey to use autocli
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

@github-actions github-actions bot added the C:CLI label Jan 12, 2024
@atheeshp atheeshp changed the title feat: add support for pubkey feat(client/v2): add support for pubkey Jan 12, 2024
@atheeshp atheeshp marked this pull request as ready for review January 12, 2024 17:01
@atheeshp atheeshp requested a review from a team as a code owner January 12, 2024 17:01

This comment has been minimized.

client/v2/autocli/flag/pubkey.go Outdated Show resolved Hide resolved
client/v2/autocli/flag/pubkey.go Outdated Show resolved Hide resolved
client/v2/autocli/flag/pubkey.go Outdated Show resolved Hide resolved
client/v2/autocli/flag/pubkey.go Outdated Show resolved Hide resolved
client/v2/autocli/flag/builder.go Show resolved Hide resolved
proto/cosmos/staking/v1beta1/tx.proto Outdated Show resolved Hide resolved
{
RpcMethod: "RotateConsPubKey",
Use: "rotate-cons-pubkey [validator-address] [new-pubkey]",
Short: "rotate validator consensus pub key. Note: you have to replace the `~/.simapp/config/priv_validator_key.json` with new key and restart the node after rotating the key ",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use version.AppName+"d" instead of simapp

Copy link
Contributor

coderabbitai bot commented Jan 12, 2024

Walkthrough

The recent updates enhance the functionality of a blockchain client by introducing support for a new public key scalar type, specifically for Cosmos. It includes the addition of this scalar type to a builder configuration, methods for handling public keys, and an update to the protocol buffer definition for staking transactions to accommodate the public key changes. Additionally, a new command has been added to the staking module to allow for the rotation of validator consensus public keys.

Changes

File Summary
client/v2/autocli/flag/pubkey.go
proto/cosmos/staking/v1beta1/tx.proto
Introduces functionality for handling public keys in the context of a client's autocli. It provides methods for creating, setting, and getting public key values, as well as defining the type of public key. Semantic change in the field tag for new_pubkey in the MsgRotateConsPubKey message. Replaced cosmos_proto.accepts_interface option with cosmos_proto.scalar. The changes in the hunks involve the addition of a new example of a pubkey scalar in the protobuf annotations. Support for pubkey in autocli added as part of pull request #19039.
x/staking/autocli.go Added a new RotateConsPubKey command to the AutoCLIOptions function for rotating the validator consensus public key.

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:

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.

Comment on lines 37 to 60
// fallback to pubkey parsing
registry := types.NewInterfaceRegistry()
cryptocodec.RegisterInterfaces(registry)
cdc := codec.NewProtoCodec(registry)

var pk cryptotypes.PubKey
err2 := cdc.UnmarshalInterfaceJSON([]byte(s), &pk)
if err2 != nil {
return fmt.Errorf("input isn't a pubkey, or is an invalid account address: %w", err2)
}

any, err := types.NewAnyWithValue(pk)
if err != nil {
return fmt.Errorf("error converting to any type")
}
a.value = any

// a.value, err = a.addressCodec.BytesToString(pk.Address())
// if err != nil {
// return fmt.Errorf("invalid pubkey address: %w", err)
// }

return nil
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The method Set in pubkeyValue struct is responsible for parsing the public key from a string and setting it to the value field. The error message in line 45 has been updated to include both cases of invalid public key and invalid account address, which is a good practice for error handling. However, the commented-out code from lines 54-57 should be removed if it's no longer needed to avoid confusion.

@atheeshp atheeshp requested a review from julienrbrt January 12, 2024 17:31
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@atheeshp atheeshp mentioned this pull request Jan 12, 2024
7 tasks
@atheeshp atheeshp added this pull request to the merge queue Jan 12, 2024
Merged via the queue into main with commit efa7636 Jan 12, 2024
60 of 63 checks passed
@atheeshp atheeshp deleted the ap/add-pubkey-support branch January 12, 2024 18:38
@coderabbitai coderabbitai bot mentioned this pull request Jan 17, 2024
12 tasks
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants