fix: permissionless added event + cli changes

[bermuell]

Description

Closes: #XXXX
Changes to enable/facilitate e2e tests:

• Added event on CreateConsumer to get consumer-id on tx
• Changed update-consumer and create-consumer cli to accept only one json file as input

---

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
• Added ! to the type prefix if the change is state-machine breaking
• Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
• Targeted the correct branch (see PR Targeting)
• Provided a link to the relevant issue or specification
• Followed the guidelines for building SDK modules
• Included the necessary unit and integration tests
• Added a changelog entry to CHANGELOG.md
• Included comments for documenting Go code
• Updated the relevant documentation or specification
• Reviewed "Files changed" and left comments if necessary
• Confirmed all CI checks have passed
• If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

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 ! the type prefix if the change is state-machine breaking
• confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
• confirmed all author checklist items have been addressed
• reviewed state machine logic
• reviewed API design and naming
• reviewed documentation is accurate
• reviewed tests and test coverage

Summary by CodeRabbit

• New Features

  • Updated command-line interface (CLI) commands for enhanced clarity, focusing on consumer identification.
  • Simplified create-consumer and update-consumer commands to require a single JSON file for input.
  • Added event emission for consumer registration to improve system notifications.

• Improvements

  • Enhanced validation and usability of CLI commands by consolidating input requirements.
  • Introduced new event types and attributes for better tracking of consumer interactions.

• Bug Fixes

  • Adjusted parameter names in commands to ensure consistency and reduce user errors.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve modifications to the command-line interface (CLI) for consumer management, focusing on replacing chain ID references with consumer ID in commands and parameters. Additionally, the structure of commands for creating and updating consumers has been simplified to use single JSON files, enhancing usability. Event handling for consumer registration has been introduced, along with new event types and attributes to improve tracking within the system.

Changes

Files	Change Summary
x/ccv/provider/client/cli/query.go	Updated CLI commands to replace chainid with consumer-id in CmdConsumerGenesis and CmdProviderValidatorKey, enhancing clarity in command usage and internal variable names.
x/ccv/provider/client/cli/tx.go	Simplified create-consumer and update-consumer commands to accept single JSON files instead of multiple parameters. Adjusted other commands to use consumer-id instead of consumer-chain-id.
x/ccv/provider/keeper/grpc_query.go	Modified QueryValidatorProviderAddr to use req.ConsumerId instead of req.ChainId, changing the logic for querying provider addresses.
x/ccv/provider/keeper/msg_server.go	Added event emission for consumer registration in the CreateConsumer method, enhancing the event-driven architecture.
x/ccv/types/events.go	Introduced new constants EventTypeConsumerRegistration and AttributeConsumerID to support consumer registration events and identification.

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0173c0d and 525afc0.

Files selected for processing (3)

• x/ccv/provider/client/cli/tx.go (7 hunks)
• x/ccv/provider/keeper/msg_server.go (1 hunks)
• x/ccv/types/events.go (2 hunks)

Files skipped from review as they are similar to previous changes (3)

• x/ccv/provider/client/cli/tx.go
• x/ccv/provider/keeper/msg_server.go
• x/ccv/types/events.go

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 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.

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.

[mpoke]

Nice catch. @insumity why do we have deprecated fields in query requests. Given that both chanId and consumerId have the same type, it's easy to have bugs where we call functions with a chainId.

[insumity]

For backward compatibility. We try to prevent chainIds from being used by doing:

} else if req.ChainId != "" {
    return nil, status.Errorf(codes.InvalidArgument, "ChainId has been deprecated. Use ConsumerId instead.")
}

But in this case we unfortunately missed it.

[mpoke]

For backward compatibility.

Can you please give more details about this. What's the use case that we want to keep compatibility with?

[insumity]

We could imagine that Hermes is using this query (QueryValidatorProviderAddr) so they use our protos to build Hermes. If we were to simply go and remove chain_id, we would break their builds. It seems, in those cases, the right approach is to just mark chain_id as deprecated. It is true that the actual query is still broken from their side but this seems less severe.
We could remove all those chain_ids if we were to bump the proto version to v2 but this seems like it would be more time consuming at this stage.

[mpoke]

Bumping the proto version is something we should talk to @MSalopek.

Regarding breaking the queries for Hermes for example, as you stated it will be broken anyway. All the users of these queries will need to update their code. Leaving chainId there seems even more dangerous to me as there is a chance that we forget to return an error and the query goes through and returns weird stuff. So my recommendation would be to remove deprecated fields from the queries.

[MSalopek]

I would avoid v2 and inform hermes that there will be a compatibility break and that they should update their code.

[mpoke]

How will the user differentiate between the json they need to provide for create-consumer and the one for update-consumer?

[bermuell]

right, we need to provide an example.
I can also imagine to have the common part's in a json file (e.g. metadata, init-, powershaping-parameters) and those which differ as mandatory/optional arguments (optional would be 'new_owner').
If you're ok I'll keep this change for later once we have a preference.
In any case we'll end up with a 'one-file solution' I'd say.

[MSalopek]

This just needs an update to the instructions.

All json fields have omitempty tag.