feat(x/gov, x/distribution): add module query safe #20248

kien6034 · 2024-05-02T11:08:20Z

Description

Closes: #20219

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

Summary by CodeRabbit

New Features
- Enhanced security by introducing cosmos.query.v1.module_query_safe options to various RPC methods in the distribution and governance modules.
- Added test functionality for querying parameters in a distributed system and testing governance-related GRPC queries.
Deprecated
- Deprecated the CommunityPool method in the distribution module, indicating potential future changes.

coderabbitai · 2024-05-02T11:08:47Z

Important

Auto Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The updates involve incorporating a new module and marking various RPC methods as safe for interchain queries in the Cosmos SDK's x/distribution and x/gov modules. This enhancement allows these queries to be executed across chains, improving the interchain functionality.

Changes

File Path	Change Summary
`x/distribution/proto/cosmos/distribution/v1beta1/query.proto`	New import; multiple RPC methods marked as `cosmos.query.v1.module_query_safe`.
`x/gov/proto/cosmos/gov/v1/query.proto`	New import; multiple RPC methods marked as `cosmos.query.v1.module_query_safe`.
`tests/integration/distribution/keeper/deterministic_test.go`	Added test functionality for querying parameters in a distributed system.
`tests/integration/gov/keeper/deterministic_test.go`	Added test functions for GRPC queries related to governance features.
`x/gov/proto/cosmos/gov/v1beta1/query.proto`	Import statement added; `cosmos.query.v1.module_query_safe` option added to various RPC methods.

Assessment against linked issues

Objective	Addressed	Explanation
Mark all `x/distribution` and `x/gov` queries with `module_query_safe` tag [#20219]	✅
Enable these queries for interchain accounts to enhance cross-chain functionality [#20219]	✅

Possibly related issues

Allow module_query_safe queries in ICA ibc-go#5784: This issue discusses enhancing ICA transactions by allowing safe queries and could benefit from the changes in this PR, as it aligns with enabling module_query_safe queries, which is a step towards the objectives of this issue.

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

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.
Please see the configuration documentation for more information.
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/schema.v2.json

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.

coderabbitai

Actionable comments posted: 1

coderabbitai

Actionable comments posted: 2

coderabbitai · 2024-05-02T11:23:51Z

api/cosmos/gov/v1/query.pulsar.go

@@ -3,6 +3,7 @@ package govv1

 import (
 	v1beta1 "cosmossdk.io/api/cosmos/base/query/v1beta1"
+	_ "cosmossdk.io/api/cosmos/query/v1"


Remove the unused import cosmos/query/v1.

This import is marked as unused with _. If it's not needed for initialization side effects, it should be removed to clean up the codebase.

coderabbitai · 2024-05-02T11:23:51Z

api/cosmos/distribution/v1beta1/query.pulsar.go

@@ -5,6 +5,7 @@ import (
 	_ "cosmossdk.io/api/amino"
 	v1beta11 "cosmossdk.io/api/cosmos/base/query/v1beta1"
 	v1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
+	_ "cosmossdk.io/api/cosmos/query/v1"


Unused import statement.

- _ "cosmossdk.io/api/cosmos/query/v1"

Please remove the import statement if it is not used within the file to avoid unnecessary clutter and potential confusion about dependencies.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

_ "cosmossdk.io/api/cosmos/query/v1"

tac0turtle

hey in order to add these we need deterministic tests so we can call out when something is breaking. You can see the other module query safe queries as examples

kien6034 · 2024-05-02T16:50:24Z

@tac0turtle sure. I'm going to add it tomorrow

coderabbitai

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

api/cosmos/gov/v1beta1/query.pulsar.go (1)

7-7: Consider adding comments next to blank imports to explain their purpose.

kien6034 · 2024-05-04T10:22:22Z

tests/integration/distribution/keeper/deterministic_test.go

+	}
+}
+
+func TestQueryParamsDeterministic(t *testing.T) {


@tac0turtle can you have a look at this, to see if i'm going the right direction.?

kien6034 requested a review from a team as a code owner May 2, 2024 11:08

github-actions bot added C:x/gov C:x/distribution distribution module related labels May 2, 2024

kien6034 added 2 commits May 2, 2024 18:12

feat: mark distribution module query safe

2f4bf53

feat: mark gov module query safe

5f3802a

coderabbitai bot reviewed May 2, 2024

View reviewed changes

chore: resolve conflict

1d84c0c

kien6034 force-pushed the feat/module-query-safe branch from 69551a0 to 1d84c0c Compare May 2, 2024 11:20

coderabbitai bot reviewed May 2, 2024

View reviewed changes

tac0turtle reviewed May 2, 2024

View reviewed changes

julienrbrt changed the title ~~feat(x/gov)(x/distribution): add module query safe~~ feat(x/gov, x/distribution): add module query safe May 3, 2024

kien6034 added 2 commits May 4, 2024 00:44

test: add base deterministic test for gov

67d7eb9

test: add distr query params

cf41e94

kien6034 marked this pull request as draft May 3, 2024 18:04

coderabbitai bot reviewed May 3, 2024

View reviewed changes

test: add distr query validator outstanding reward

4317d9d

kien6034 mentioned this pull request May 4, 2024

refactor(tests/integration/distribution): using setupValidatorWithCommission helper function #20275

Merged

12 tasks

kien6034 commented May 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(x/gov, x/distribution): add module query safe #20248

feat(x/gov, x/distribution): add module query safe #20248

kien6034 commented May 2, 2024 •

edited by coderabbitai bot

coderabbitai bot commented May 2, 2024 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot May 2, 2024

coderabbitai bot May 2, 2024

tac0turtle left a comment

kien6034 commented May 2, 2024

coderabbitai bot left a comment

kien6034 May 4, 2024 •

edited

feat(x/gov, x/distribution): add module query safe #20248

Are you sure you want to change the base?

feat(x/gov, x/distribution): add module query safe #20248

Conversation

kien6034 commented May 2, 2024 • edited by coderabbitai bot

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented May 2, 2024 • edited

Auto Review Skipped

Walkthrough

Changes

Assessment against linked issues

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot May 2, 2024

Choose a reason for hiding this comment

coderabbitai bot May 2, 2024

Choose a reason for hiding this comment

tac0turtle left a comment

Choose a reason for hiding this comment

kien6034 commented May 2, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

kien6034 May 4, 2024 • edited

Choose a reason for hiding this comment

kien6034 commented May 2, 2024 •

edited by coderabbitai bot

coderabbitai bot commented May 2, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

kien6034 May 4, 2024 •

edited