cosmos-sdk icon indicating copy to clipboard operation
cosmos-sdk copied to clipboard

feat(x/gov): Add Query for getting Last Proposal ID

Open mattverse opened this issue 1 year ago • 5 comments

Description

A QOL addition in gov module for getting last proposal Id stored on-chain. There are instances where we want to know our proposal id after submitting a proposal, and the current method people use would be either to

  • break down tx result after submitting proposal OR
  • do gov q proposals and use jq and grep combinations to get the last proposal Id, which IMO is a bad dev ux and can be very much simplified.

I did notice there were minimal cli commands in the gov module, if this was intended and the goal is to keep the gov module minimal, OR if others do not think this isn't worth the extra complexity in codebase happy to close this PR! If not, happy to go ahead and add test cases + add changelog :)

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

  • [x] included the correct type prefix in the PR title
  • [x] confirmed ! in the type prefix if API or client breaking change
  • [x] targeted the correct branch (see PR Targeting)
  • [ ] provided a link to the relevant issue or specification
  • [x] 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

Summary by CodeRabbit

  • New Features
    • Enhanced user interaction by introducing a feature to directly query the last proposal ID from the app.

mattverse avatar Feb 08 '24 08:02 mattverse

Walkthrough

Walkthrough

The update enriches the Cosmos governance module by introducing a new feature to query the last proposal ID. This enhancement involves adding a LastProposalId function across various files to enable this functionality, encompassing gRPC service definitions, command-line interface options, and server logic. Users can now conveniently retrieve the most recent proposal ID from the blockchain state, improving their interaction with governance proposals.

Changes

File(s) Change Summary
api/cosmos/gov/v1/query_grpc.pb.go, proto/cosmos/gov/v1/query.proto Added LastProposalId function to query the last proposal ID in cosmos.gov.v1.Query service.
x/gov/autocli.go, x/gov/keeper/grpc_query.go Introduced LastProposalId RPC method in AutoCLI options and implemented the function for retrieving the last proposal ID.
x/gov/types/v1/query.pb.gw.go Improved handling and forwarding for last proposal ID queries with new functions and updated handlers.
CHANGELOG.md, x/gov/keeper/grpc_query_test.go Updated documentation and added test coverage for the new LastProposalId functionality.

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>.
    • Generate unit-tests for this file.
  • 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.

coderabbitai[bot] avatar Feb 08 '24 08:02 coderabbitai[bot]

I'm not sure we should add an api like this. If there is a way we can do this via cli only. Adding new endpoints like this end up adding up quickly and we would like to reduce the interface and enable users to better use off chain ways to handle this.

tac0turtle avatar Feb 08 '24 18:02 tac0turtle

I'm not sure we should add an api like this. If there is a way we can do this via cli only. Adding new endpoints like this end up adding up quickly and we would like to reduce the interface and enable users to better use off chain ways to handle this.

If we want to use AutoCLI we'll need to add a query.

julienrbrt avatar Feb 09 '24 08:02 julienrbrt

dding new endpoints like this end up adding up quickly and we would like to reduce the interface and enable users to better use off chain ways to handle this.

Yeah that's what I thought might be the case as well. I have made change requested above, happy either way :)

mattverse avatar Feb 12 '24 15:02 mattverse

Added unit test + changelog entry :)

mattverse avatar Feb 13 '24 08:02 mattverse

Makes sense. Thanks :)

mattverse avatar Feb 28 '24 10:02 mattverse