search

osmosis-labs / osmosis

The AMM Laboratory
https://app.osmosis.zone
Apache License 2.0
893 stars 595 forks source link

Chore/update error message #8816

Closed PaddyMc closed 2 weeks ago

PaddyMc commented 2 weeks ago

What is the purpose of the change

Updating error message on panic

Where is the change documented?

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request involve updates to error handling in three files: spread_rewards.go, bankactions.go, and errors.go. In spread_rewards.go, the panic messages for negative values of spreadFactor and spreadRewardChargeTotal are enhanced with additional context. In bankactions.go, the methods mintTo, burnFrom, and forceTransfer are modified to improve error handling related to module accounts, particularly by changing the order of operations in the mintTo method. Additionally, a new error variable ErrMintToModuleAccount is introduced in errors.go.

Changes

File Path Change Summary
x/concentrated-liquidity/swapstrategy/... Updated panic messages in computeSpreadRewardChargePerSwapStepOutGivenIn for clarity.
x/tokenfactory/keeper/... Modified mintTo, burnFrom, and forceTransfer methods to enhance error handling for module accounts.
x/tokenfactory/types/errors.go Introduced new error variable ErrMintToModuleAccount with a descriptive message.

Suggested reviewers

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between b85a0ae6236e3210ff337b6f91fc4b2a8f7d0834 and 31b9c31aa02f92680509b2523ca127f829dafc7a.
📒 Files selected for processing (3) * `x/concentrated-liquidity/swapstrategy/spread_rewards.go` (2 hunks) * `x/tokenfactory/keeper/bankactions.go` (1 hunks) * `x/tokenfactory/types/errors.go` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * x/concentrated-liquidity/swapstrategy/spread_rewards.go * x/tokenfactory/keeper/bankactions.go
🔇 Additional comments (1)
x/tokenfactory/types/errors.go (1) `24-24`: **LGTM! The error registration follows best practices.** The new error variable is well-defined with a clear message and follows the established pattern for error registration in the module. Let's verify the uniqueness of the error code:
✅ Verification successful **Error code 13 is unique within the tokenfactory module** The verification confirms that the new error code 13 for `ErrMintToModuleAccount` is unique within the tokenfactory module. All error codes (2-13) are sequential and used exactly once.
🏁 Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Check for any duplicate error codes in the tokenfactory module # Expected: No duplicate error codes should be found # Search for error code registrations in the tokenfactory module rg --type go "errorsmod\.Register\(.*,\s*\d+\s*," x/tokenfactory/ ``` Length of output: 1701

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.