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(x/bank): adding DenomOwnersByQuery for denom owners for token #18956

Merged
merged 14 commits into from
Jan 10, 2024

Conversation

gsai967
Copy link
Contributor

@gsai967 gsai967 commented Jan 5, 2024

Description

Closes: #18917

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

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

coderabbitai bot commented Jan 5, 2024

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.

@gsai967
Copy link
Contributor Author

gsai967 commented Jan 5, 2024

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

CHANGELOG.md Outdated Show resolved Hide resolved
@julienrbrt 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
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.

The new query should be added here as well:

## gRPC

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
@gsai967 gsai967 requested a review from julienrbrt January 9, 2024 10:17
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

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

x/bank/CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
proto/cosmos/bank/v1beta1/query.proto Show resolved Hide resolved
@gsai967 gsai967 requested a review from julienrbrt January 10, 2024 12:49
// denomination.
//
// Since: cosmos-sdk 0.50.3
message QueryDenomOwnersByQueryRequest {
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

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.

utACK

@atheeshp 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
@julienrbrt
Copy link
Member

@Mergifyio backport release/v0.50.x

Copy link
Contributor

mergify bot commented Jan 10, 2024

backport release/v0.50.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jan 10, 2024
…18956)

Co-authored-by: Sai Kumar <[email protected]>
(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
julienrbrt added a commit that referenced this pull request Jan 10, 2024
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
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.

[Bug]: LCD queries with {denom} don't work with slashes
6 participants