Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Disable MsgCancelProposal #1015

Merged
merged 2 commits into from
Jan 26, 2024
Merged

Disable MsgCancelProposal #1015

merged 2 commits into from
Jan 26, 2024

Conversation

teddyding
Copy link
Contributor

Changelist

  • Disable MsgCancelProposal which was a new message introduced in Cosmos SDK 0.50 (Context here)

Test Plan

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

@teddyding teddyding marked this pull request as ready for review January 26, 2024 01:36
Copy link
Contributor

coderabbitai bot commented Jan 26, 2024

Walkthrough

The recent modifications involve shifting MsgCancelProposal and MsgCancelProposalResponse from the cosmos.gov.v1 package to a different location, marking a deprecation of support for MsgSubmitProposal and MsgSubmitProposalResponse from the govbeta package. This reorganization includes importing the gov package from a specific GitHub repository and adjusting the test expectations to align with these changes, reflecting a strategic update in message handling and support within the protocol.

Changes

Files Change Summary
.../msgs/normal_msgs.go, .../normal_msgs_test.go Removed MsgCancelProposal and MsgCancelProposalResponse from cosmos.gov.v1.
.../msgs/unsupported_msgs.go, .../unsupported_msgs_test.go, .../lib/ante/unsupported_msgs.go Imported gov package from github.com/cosmos/cosmos-sdk/x/gov/types/v1. Added MsgCancelProposal and MsgCancelProposalResponse from the gov package. Deprecated support for MsgSubmitProposal and MsgSubmitProposalResponse from govbeta. Modified the IsUnsupportedMsg function to include a check for gov.MsgCancelProposal in addition to govbeta.MsgSubmitProposal.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a13958a and c5bc798.
Files selected for processing (4)
  • protocol/app/msgs/normal_msgs.go (1 hunks)
  • protocol/app/msgs/normal_msgs_test.go (1 hunks)
  • protocol/app/msgs/unsupported_msgs.go (2 hunks)
  • protocol/app/msgs/unsupported_msgs_test.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • protocol/app/msgs/normal_msgs_test.go
Additional comments: 2
protocol/app/msgs/unsupported_msgs_test.go (1)
  • 14-15: The addition of "/cosmos.gov.v1.MsgCancelProposal" and "/cosmos.gov.v1.MsgCancelProposalResponse" to the expected message list in TestUnsupportedMsgSamples_Key correctly reflects the PR's objective to mark these messages as unsupported. This change ensures that the test aligns with the updated protocol behavior.
protocol/app/msgs/unsupported_msgs.go (1)
  • 5-5: The import of the gov package from github.com/cosmos/cosmos-sdk/x/gov/types/v1 is correctly added to support the declaration of MsgCancelProposal and MsgCancelProposalResponse as unsupported messages. This change is necessary for the implementation of the PR's objectives.

Comment on lines +14 to +17
// MsgCancelProposal is not allowed by protocol, due to it's potential for abuse.
"/cosmos.gov.v1.MsgCancelProposal": &gov.MsgCancelProposal{},
"/cosmos.gov.v1.MsgCancelProposalResponse": nil,
// These are deprecated/legacy msgs that we should not support.
Copy link
Contributor

Choose a reason for hiding this comment

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

The declarations for "/cosmos.gov.v1.MsgCancelProposal" and "/cosmos.gov.v1.MsgCancelProposalResponse" as unsupported messages are correctly implemented. This aligns with the PR's objective to disable these message types. However, setting the MsgCancelProposalResponse to nil might not be the best approach if the intention is to explicitly mark it as unsupported. Consider providing a stub or a specific unsupported message response to handle any potential calls to this message type more gracefully.

- "/cosmos.gov.v1.MsgCancelProposalResponse": nil,
+ "/cosmos.gov.v1.MsgCancelProposalResponse": &gov.MsgCancelProposalResponse{ /* fields if necessary */ },

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
// MsgCancelProposal is not allowed by protocol, due to it's potential for abuse.
"/cosmos.gov.v1.MsgCancelProposal": &gov.MsgCancelProposal{},
"/cosmos.gov.v1.MsgCancelProposalResponse": nil,
// These are deprecated/legacy msgs that we should not support.
// MsgCancelProposal is not allowed by protocol, due to it's potential for abuse.
"/cosmos.gov.v1.MsgCancelProposal": &gov.MsgCancelProposal{},
"/cosmos.gov.v1.MsgCancelProposalResponse": &gov.MsgCancelProposalResponse{ /* fields if necessary */ },
// These are deprecated/legacy msgs that we should not support.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c5bc798 and 3264018.
Files selected for processing (1)
  • protocol/lib/ante/unsupported_msgs.go (2 hunks)
Additional comments: 2
protocol/lib/ante/unsupported_msgs.go (2)
  • 5-5: The addition of the gov package import from github.com/cosmos/cosmos-sdk/x/gov/types/v1 is correctly aligned with the PR's objective to handle MsgCancelProposal as an unsupported message. This change is necessary for the subsequent logic that checks for gov.MsgCancelProposal type in the IsUnsupportedMsg function.
  • 20-21: The modification to include *gov.MsgCancelProposal in the IsUnsupportedMsg function's case statement effectively marks MsgCancelProposal as unsupported, aligning with the PR's objectives. This change is straightforward and correctly implements the logic to identify MsgCancelProposal as an unsupported message type. However, ensure that all references and usages of MsgCancelProposal throughout the codebase have been updated to reflect this change.

@teddyding teddyding merged commit 39046a5 into main Jan 26, 2024
17 checks passed
@teddyding teddyding deleted the td/disable-cancellation branch January 26, 2024 20:59
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants