feat(x/bank): adding DenomOwnersByQuery for denom owners for token #18956

gsai967 · 2024-01-05T17:30:53Z

Description

The current DenomOwners query does not works with token denom values which have "/" in them , we have to pass denom value as query string to DenomOwners.

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 · 2024-01-05T17:31:04Z

Walkthrough

The Cosmos SDK repository has undergone changes to address issues with querying denoms (token denominations) that contain slashes. The DenomsMetadata RPC has been renamed to DenomMetadata, and a similar change has been made to DenomsMetadataByQueryString, now DenomMetadataByQueryString. A new RPC DenomOwnersByQuery and corresponding message types have been added to facilitate queries for account addresses owning a specific denom. This addresses a bug related to denom queries in the LCD endpoints, particularly for denoms with slashes that previously could not be queried due to URL path constraints.

Changes

File(s)	Change Summary
`proto/cosmos/bank/v1beta1/query.proto`	Renamed RPCs for denom metadata and added `DenomOwnersByQuery` RPC with new message types for requests and responses.
`x/bank/keeper/grpc_query.go`	Refactored `DenomMetadataByQueryString` to use `DenomMetadata` and added `DenomOwnersByQuery` function.
`x/bank/keeper/grpc_query_test.go`	Added `TestGRPCDenomOwnersByQuery` for testing the new denom owners query functionality.
`x/bank/CHANGELOG.md`	Updated changelog with a summary of the new query method for denom owners.
`proto/cosmos/protocolpool/v1/tx.proto`	Removed a field from `MsgWithdrawContinuousFundResponse` message.

Assessment against linked issues

Objective	Addressed	Explanation
#18917: Resolve issues with querying denoms with slashes in LCD endpoints	✅	The addition of the `DenomOwnersByQuery` RPC and refactoring of related functions directly address the inability to query denoms with slashes, providing a workaround to the limitation of the URL path in HTTP requests.
Ensure new RPC `DenomOwnersByQuery` correctly returns account addresses owning a specific denom	✅	The corresponding test function `TestGRPCDenomOwnersByQuery` in `grpc_query_test.go` indicates that the new functionality is covered by unit tests, although actual test results are not provided.
Rename RPCs for clarity and consistency	✅	The renaming of `DenomsMetadata` to `DenomMetadata` and `DenomsMetadataByQueryString` to `DenomMetadataByQueryString` in `query.proto` reflects a clearer and more consistent naming convention.

The code changes appear to address the primary objectives of the linked issue, enhancing the Cosmos SDK's ability to handle denom queries, especially for those containing problematic characters like slashes.

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.

…x_denom_owners

gsai967 · 2024-01-05T17:38:55Z

I don't want to break current DenonOwners grpc method, so I added new one DenomOwnersByQuery grpc get method

CHANGELOG.md

x/bank/keeper/grpc_query.go

proto/cosmos/bank/v1beta1/query.proto

julienrbrt

The new query should be added here as well:

cosmos-sdk/x/bank/README.md

Line 737 in b16aa35

## gRPC

proto/cosmos/bank/v1beta1/query.proto

CHANGELOG.md

likhita-809

need to update changelog and address julien's comment on adding new gRPC query in bank's README

x/bank/CHANGELOG.md

CHANGELOG.md

proto/cosmos/bank/v1beta1/query.proto

coderabbitai · 2024-01-10T12:51:05Z

proto/cosmos/bank/v1beta1/query.proto

+// denomination.
+//
+// Since: cosmos-sdk 0.50.3
+message QueryDenomOwnersByQueryRequest {


Regarding the discussion about the since comment, it seems there is a consensus that it should be included and specify the version 0.50.3 or 0.50.4 depending on when the PR is merged. This should be finalized before merging.

julienrbrt

utACK

julienrbrt · 2024-01-10T14:54:49Z

@Mergifyio backport release/v0.50.x

mergify · 2024-01-10T14:55:00Z

backport release/v0.50.x

✅ Backports have been created

#19007 feat(x/bank): adding DenomOwnersByQuery for denom owners for token (backport #18956) has been created for branch release/v0.50.x but encountered conflicts

…18956) Co-authored-by: Sai Kumar <gskumar967@gmail.com> (cherry picked from commit dee9eda) # Conflicts: # CHANGELOG.md # client/docs/swagger-ui/swagger.yaml # proto/cosmos/protocolpool/v1/tx.proto # x/bank/CHANGELOG.md # x/bank/keeper/grpc_query.go # x/bank/types/query.pb.go

…ackport #18956) (#19007) Co-authored-by: gsai967 <153279976+gsai967@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>

…osmos#18956) Co-authored-by: Sai Kumar <gskumar967@gmail.com>

adding DenomOwnersByQuery for denom owners for token

368d337

gsai967 requested a review from a team as a code owner January 5, 2024 17:30

Merge branch 'main' into sk/fix_denom_owners

6c79e62

github-actions bot added C:CLI C:x/bank labels Jan 5, 2024

gsk967 added 2 commits January 5, 2024 23:04

update the changelog

ba6a56c

Merge remote-tracking branch 'gsai967/sk/fix_denom_owners' into sk/fi…

dad74d6

…x_denom_owners

coderabbitai bot reviewed Jan 5, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

julienrbrt changed the title ~~chore: adding DenomOwnersByQuery for denom owners for token~~ feat(x/bank): adding DenomOwnersByQuery for denom owners for token Jan 5, 2024

alexanderbez reviewed Jan 8, 2024

View reviewed changes

x/bank/keeper/grpc_query.go Show resolved Hide resolved

gsk967 added 2 commits January 9, 2024 14:29

Merge branch 'main' into sk/fix_denom_owners

80614f0

update the changelog

a804526

atheeshp reviewed Jan 9, 2024

View reviewed changes

proto/cosmos/bank/v1beta1/query.proto Outdated Show resolved Hide resolved

update the go doc for query

4d7960c

gsai967 requested review from atheeshp and alexanderbez January 9, 2024 09:49

Merge branch 'main' into sk/fix_denom_owners

c3db62c

julienrbrt requested changes Jan 9, 2024

View reviewed changes

proto/cosmos/bank/v1beta1/query.proto Show resolved Hide resolved

proto/cosmos/bank/v1beta1/query.proto Show resolved Hide resolved

proto/cosmos/bank/v1beta1/query.proto Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

update the bank changelog

cae43a5

gsai967 requested a review from julienrbrt January 9, 2024 10:17

alexanderbez approved these changes Jan 9, 2024

View reviewed changes

likhita-809 approved these changes Jan 10, 2024

View reviewed changes

x/bank/CHANGELOG.md Show resolved Hide resolved

gsai967 added 2 commits January 10, 2024 11:52

Merge branch 'main' into sk/fix_denom_owners

cd6a556

Merge branch 'main' into sk/fix_denom_owners

f2b7daf

julienrbrt reviewed Jan 10, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

proto/cosmos/bank/v1beta1/query.proto Show resolved Hide resolved

gsai967 and others added 3 commits January 10, 2024 18:17

add since comment to denomOwersByQuery

aead500

update the changelog

e113c30

Merge branch 'main' into sk/fix_denom_owners

d88a08a

gsai967 requested a review from julienrbrt January 10, 2024 12:49

coderabbitai bot reviewed Jan 10, 2024

View reviewed changes

julienrbrt approved these changes Jan 10, 2024

View reviewed changes

atheeshp added this pull request to the merge queue Jan 10, 2024

Merged via the queue into cosmos:main with commit dee9eda Jan 10, 2024
57 of 59 checks passed

mergify bot mentioned this pull request Jan 10, 2024

feat(x/bank): adding DenomOwnersByQuery for denom owners for token (backport #18956) #19007

Merged

relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024

feat(x/bank): adding DenomOwnersByQuery for denom owners for token (c…

64a97c7

…osmos#18956) Co-authored-by: Sai Kumar <gskumar967@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/bank): adding DenomOwnersByQuery for denom owners for token #18956

feat(x/bank): adding DenomOwnersByQuery for denom owners for token #18956

gsai967 commented Jan 5, 2024

coderabbitai bot commented Jan 5, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

gsai967 commented Jan 5, 2024

julienrbrt left a comment

likhita-809 left a comment

coderabbitai bot Jan 10, 2024

julienrbrt left a comment

julienrbrt commented Jan 10, 2024

mergify bot commented Jan 10, 2024 •

edited

Loading

feat(x/bank): adding DenomOwnersByQuery for denom owners for token #18956

feat(x/bank): adding DenomOwnersByQuery for denom owners for token #18956

Conversation

gsai967 commented Jan 5, 2024

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented Jan 5, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

gsai967 commented Jan 5, 2024

julienrbrt left a comment

Choose a reason for hiding this comment

likhita-809 left a comment

Choose a reason for hiding this comment

coderabbitai bot Jan 10, 2024

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

julienrbrt commented Jan 10, 2024

mergify bot commented Jan 10, 2024 • edited Loading

✅ Backports have been created

coderabbitai bot commented Jan 5, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

mergify bot commented Jan 10, 2024 •

edited

Loading