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

fix: validate MsgUpsertFeeDenom #176

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

freeelancer
Copy link
Contributor

@freeelancer freeelancer commented Oct 6, 2024

Summary by CodeRabbit

  • New Features

    • Updated fee handling logic to ensure excess fees are refunded to the payer instead of treated as tips.
    • Enhanced validation for the Multiplier field in fee denomination messages to prevent negative values.
  • Bug Fixes

    • Refined error messages and validation conditions for fee-related transactions to improve clarity and accuracy.

Copy link

coderabbitai bot commented Oct 6, 2024

Walkthrough

The changes in this pull request primarily involve updates to the FeeMarketDeductDecorator struct and the MsgUpsertFeeDenom struct. The modifications clarify fee handling, specifically regarding refunds for excess fees, and adjust the validation logic for the Multiplier field to prevent negative values. Comments throughout the affected methods have been refined to better reflect the intended functionality.

Changes

File Path Change Summary
x/xfeemarket/post/fee.go Updated comments in FeeMarketDeductDecorator and PostHandle methods to clarify fee refund logic. Retained functionality in BurnFeeAndRefund.
x/xfeemarket/types/message_upsert_fee_denom.go Modified Validate method in MsgUpsertFeeDenom to check if Multiplier is less than or equal to zero, with updated error message.

Possibly related PRs

Suggested reviewers

  • mantrachain-support

Poem

In the market of fees, we dance and play,
Refunds now clear, in a bright, new way.
With multipliers checked, no negatives found,
Clarity reigns, in code we are bound.
So hop with delight, let the changes unfold,
For a rabbit's sweet tale is worth more than gold! 🐰✨


🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

Copy link

sonarqubecloud bot commented Oct 6, 2024

Copy link

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
x/xfeemarket/types/message_upsert_fee_denom.go (1)

27-28: Approve change with minor suggestion for error message.

The update to the Validate method is a good improvement. It now correctly prevents both zero and negative values for the Multiplier, which aligns with typical expectations for a multiplier in financial calculations.

However, there's a minor grammatical issue in the error message that could be improved for clarity.

Consider updating the error message for better readability:

- return errors.New("multiplier cannot be less than equal 0")
+ return errors.New("multiplier cannot be less than or equal to 0")
x/xfeemarket/post/fee.go (1)

19-19: Approved: Clarification on fee refund policy

The updated comment accurately reflects the fee handling process, stating that excess fees are refunded to the payer. This change improves clarity for users and developers.

Consider adding a brief mention of what happens when the provided fee is less than the minimum base fee, for completeness:

- // Excess between the given fee and the on-chain min base fee is refunded to payer.
+ // Excess between the given fee and the on-chain min base fee is refunded to payer.
+ // If the given fee is less than the min base fee, the transaction will fail.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8b6e6c6 and bfb9188.

📒 Files selected for processing (2)
  • x/xfeemarket/post/fee.go (1 hunks)
  • x/xfeemarket/types/message_upsert_fee_denom.go (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
x/xfeemarket/types/message_upsert_fee_denom.go (1)

Line range hint 1-31: Overall assessment: Changes effectively improve MsgUpsertFeeDenom validation.

The modifications to the Validate method of MsgUpsertFeeDenom align well with the PR objectives. The updated condition now prevents both zero and negative values for the Multiplier, which is a more robust validation approach. This change enhances the overall integrity of the fee market system by ensuring that only positive multipliers are accepted.

@mantrachain-support mantrachain-support enabled auto-merge (squash) October 7, 2024 02:55
@mantrachain-support mantrachain-support merged commit 0a6068e into main Oct 7, 2024
25 checks passed
@freeelancer freeelancer deleted the fix/negative-multiplier-for-fee-denom branch October 7, 2024 06:07
This was referenced Oct 14, 2024
@coderabbitai coderabbitai bot mentioned this pull request Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants