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: protorev throws a nil pointer #8663

Merged
merged 3 commits into from
Sep 2, 2024
Merged

fix: protorev throws a nil pointer #8663

merged 3 commits into from
Sep 2, 2024

Conversation

PaddyMc
Copy link
Contributor

@PaddyMc PaddyMc commented Sep 2, 2024

What is the purpose of the change

Fix the nil pointer exception in protorev:
ERR ProtoRevTrade failed with error: protorev failed due to internal reason: runtime error: invalid memory address or nil pointer dereference module=server

This error happens as the protorev account is not charged taker fees.

We return sdk.Coin{} => https://github.com/osmosis-labs/osmosis/blob/main/x/poolmanager/taker_fee.go#L137

We should return sdk.Coin("denom",0)

Here it's returned => https://github.com/osmosis-labs/osmosis/blob/v26.x/x/poolmanager/router.go#L78

We then call .Add on a nil value causing a panic => https://github.com/osmosis-labs/osmosis/blob/v26.x/x/poolmanager/router.go#L87

Then panic is caught in protorev

How to test

Copy link
Contributor

coderabbitai bot commented Sep 2, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve adjustments to the chargeTakerFee function in the Keeper struct, specifically altering the return values when the taker fee is bypassed. The function now consistently returns a sdk.Coin object initialized with a zero value instead of an empty object. Additionally, a fix for a nil pointer issue in the protorev functionality has been documented in the CHANGELOG.md.

Changes

Files Change Summary
x/poolmanager/taker_fee.go Modified the chargeTakerFee function to return a sdk.Coin initialized with zero value instead of an empty sdk.Coin when the taker fee is bypassed.
CHANGELOG.md Added an entry documenting a fix for a nil pointer issue in the protorev functionality, along with routine updates to dependencies.

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.
    • @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.
Early access features: disabled

We are currently testing the following features in early access:

  • Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues on the discussion post.

@PaddyMc PaddyMc added A:backport/v26.x backport patches to v26.x branch V:state/breaking State machine breaking PR labels Sep 2, 2024
Copy link
Member

@p0mvn p0mvn left a comment

Choose a reason for hiding this comment

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

Nice catch!

x/poolmanager/taker_fee.go Outdated Show resolved Hide resolved
@PaddyMc PaddyMc merged commit 362a01b into main Sep 2, 2024
1 check passed
@PaddyMc PaddyMc deleted the fix/protorev-nil-pointer branch September 2, 2024 19:55
mergify bot pushed a commit that referenced this pull request Sep 2, 2024
* fix: protorev throws a nil pointer

* chore: add changelog entry

* fix: pre allocate the zero int

(cherry picked from commit 362a01b)
PaddyMc added a commit that referenced this pull request Sep 2, 2024
* fix: protorev throws a nil pointer

* chore: add changelog entry

* fix: pre allocate the zero int

(cherry picked from commit 362a01b)

Co-authored-by: PaddyMc <[email protected]>
Copy link
Member

@czarcas7ic czarcas7ic left a comment

Choose a reason for hiding this comment

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

Nice catch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v26.x backport patches to v26.x branch C:x/poolmanager V:state/breaking State machine breaking PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants