fix: active orders overflow bug

[p0mvn]

Discovered overflow when computing the price scaling factor. Instead, we can get it from cache.

curl -X 'GET'     'http://localhost:9092/passthrough/active-orders?userOsmoAddress=osmo1q8709l2656zjtg567xnrxjr6j35a2pvwhxxms2'     -H 'accept: application/json' | jq .

Summary by CodeRabbit

• New Features

  • Enhanced order creation process with improved error handling for normalization factors.
  • Updated method for calculating normalized prices to increase robustness.

• Bug Fixes

  • Resolved issues related to the previous normalization factor calculation, improving overall order processing logic.

[coderabbitai]

Walkthrough

The changes made to the createLimitOrder method of the orderbookUseCaseImpl class focus on modifying how the normalization factor is calculated and introducing error handling. Instead of deriving the normalization factor through a mathematical operation, it now utilizes the GetSpotPriceScalingFactorByDenom method from the tokensUsecase interface. The calculation of the normalizedPrice has also changed from division to multiplication with the normalization factor.

Changes

Files	Change Summary
orderbook/usecase/orderbook_usecase.go	Modified the createLimitOrder method to retrieve the normalization factor via a new method, added error handling, and changed the calculation of normalizedPrice from division to multiplication.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OrderbookUseCase
    participant TokensUsecase

    User->>OrderbookUseCase: createLimitOrder(...)
    OrderbookUseCase->>TokensUsecase: GetSpotPriceScalingFactorByDenom(...)
    TokensUsecase-->>OrderbookUseCase: normalizationFactor or error
    alt if no error
        OrderbookUseCase->>OrderbookUseCase: Calculate normalizedPrice (multiplication)
        OrderbookUseCase-->>User: Order created successfully
    else
        OrderbookUseCase-->>User: Error message
    end

Loading

Poem

In the realm of trades where rabbits roam,
New paths we carve in our digital home.
With factors that scale like a hop in the air,
We handle our errors with utmost care.
So let’s celebrate with a jump and a cheer,
For a smoother order book, the future is near! 🐇✨

---

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
• Mastodon
• Reddit
• LinkedIn

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17169ac and da9ed54.

Files selected for processing (1)

• orderbook/usecase/orderbook_usecase.go (2 hunks)

Additional comments not posted (2)

orderbook/usecase/orderbook_usecase.go (2)

294-294: Review the calculation of normalizedPrice.

The calculation of normalizedPrice has been updated to use multiplication with the normalizationFactor. Ensure this change aligns with the intended logic and does not introduce any discrepancies in price normalization.

Consider verifying the impact of this change on the order processing logic.

---

224-227: Ensure error handling for GetSpotPriceScalingFactorByDenom.

The error handling for retrieving the normalization factor is correctly implemented. Ensure that this method is robust and handles edge cases effectively.

Run the following script to verify the implementation of GetSpotPriceScalingFactorByDenom:

Verification successful

---

Error handling for GetSpotPriceScalingFactorByDenom is correctly implemented.

The function GetSpotPriceScalingFactorByDenom in tokens/usecase/tokens_usecase.go includes appropriate error handling, ensuring robustness in retrieving the scaling factor.

• File: tokens/usecase/tokens_usecase.go
• Function: GetSpotPriceScalingFactorByDenom

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the implementation of `GetSpotPriceScalingFactorByDenom`.

# Test: Search for the function implementation. Expect: Correct error handling and edge case management.
ast-grep --lang go --pattern $'func GetSpotPriceScalingFactorByDenom($_, $_) ($_, error) {
  $$$
}'

Length of output: 100

---

Script:

#!/bin/bash
# Description: Search for the function `GetSpotPriceScalingFactorByDenom` in interfaces or other related patterns.

# Test: Search for the function definition in interfaces.
rg 'GetSpotPriceScalingFactorByDenom' -A 3 --type go

Length of output: 3462

[deividaspetraitis]

Looks good to me, I have also verified that change does not effect output by runnig a diff on after/before responses.