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

Cast oracle price to bigint and then numeric to get proper values #2689

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

shrenujb
Copy link
Contributor

@shrenujb shrenujb commented Jan 15, 2025

Changelist

Currently, the conversion of the calculated oracle price to a numeric type leads to truncation for some reason which leads to an oracle price of 0
The solution here is to first cast the calculated value to a bigint and follow that with a numeric

Test Plan

Added test

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.

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced market price update handling for markets with very low exponent values
  • Bug Fixes

    • Improved oracle price calculation precision for market price updates
  • Tests

    • Added new test case to validate market price updates with low exponent values

The changes improve the system's ability to handle market price updates with extremely precise pricing models, ensuring accurate data processing and representation.

@shrenujb shrenujb requested a review from a team as a code owner January 15, 2025 19:02
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The changes involve modifications to test constants and a SQL function related to market price updates. The primary focus is on handling markets with very low exponent values. A new test constant defaultMarketPriceUpdate3 has been added to test scenarios with low exponent precision. The SQL function dydx_market_price_update_handler has been updated to improve numeric precision calculations, specifically by changing the exponent casting and ensuring proper numeric conversion.

Changes

File Change Summary
indexer/packages/postgres/__tests__/helpers/constants.ts Updated exponent in isolatedMarket2 from -12 to -20
indexer/services/ender/__tests__/handlers/markets/market-price-update-handler.test.ts Added new test case for market price update with low exponent
indexer/services/ender/__tests__/helpers/constants.ts Added new constant defaultMarketPriceUpdate3
indexer/services/ender/src/scripts/handlers/dydx_market_price_update_handler.sql Modified oracle price calculation with updated type casting

Sequence Diagram

sequenceDiagram
    participant Test as Market Price Update Test
    participant Handler as Price Update Handler
    participant DB as Database
    
    Test->>Handler: Trigger with low exponent market event
    Handler->>DB: Calculate oracle price
    DB-->>Handler: Return processed price
    Handler-->>Test: Confirm price calculation
Loading

Poem

🐰 In the realm of markets so precise,
Where numbers dance and exponents rise,
A rabbit's code with care unfurls,
Precision's magic gently swirls,
From -12 to -20, we optimize! 🔢


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9db19a0 and 5dc0861.

📒 Files selected for processing (4)
  • indexer/packages/postgres/__tests__/helpers/constants.ts (1 hunks)
  • indexer/services/ender/__tests__/handlers/markets/market-price-update-handler.test.ts (2 hunks)
  • indexer/services/ender/__tests__/helpers/constants.ts (1 hunks)
  • indexer/services/ender/src/scripts/handlers/dydx_market_price_update_handler.sql (2 hunks)
🧰 Additional context used
📓 Learnings (1)
indexer/services/ender/src/scripts/handlers/dydx_market_price_update_handler.sql (1)
Learnt from: hwray
PR: dydxprotocol/v4-chain#2597
File: indexer/services/ender/src/scripts/handlers/dydx_update_perpetual_v1_handler.sql:16-20
Timestamp: 2024-11-22T18:12:04.606Z
Learning: Avoid suggesting changes to deprecated functions such as `dydx_update_perpetual_v1_handler` in `indexer/services/ender/src/scripts/handlers/dydx_update_perpetual_v1_handler.sql` if they are unchanged in the PR.
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: call-build-ecs-service-vulcan / (vulcan) Check docker image build
  • GitHub Check: call-build-ecs-service-socks / (socks) Check docker image build
  • GitHub Check: call-build-ecs-service-roundtable / (roundtable) Check docker image build
  • GitHub Check: call-build-ecs-service-ender / (ender) Check docker image build
  • GitHub Check: call-build-ecs-service-comlink / (comlink) Check docker image build
  • GitHub Check: check-build-bazooka
  • GitHub Check: test / run_command
  • GitHub Check: check-build-auxo
  • GitHub Check: Analyze (go)
  • GitHub Check: Summary
🔇 Additional comments (5)
indexer/services/ender/src/scripts/handlers/dydx_market_price_update_handler.sql (1)

30-31: LGTM! Improved numeric precision handling.

The changes improve the handling of markets with very low exponents by:

  1. Casting the exponent to bigint before the power calculation
  2. Casting the entire expression to numeric after multiplication
indexer/services/ender/__tests__/handlers/markets/market-price-update-handler.test.ts (1)

158-189: Well-structured test case for handling markets with very low exponents!

The test case follows the established pattern and thoroughly verifies the oracle price handling for markets with very low exponents.

indexer/services/ender/__tests__/helpers/constants.ts (1)

70-75: LGTM! Well-defined test constant.

The constant is properly structured and uses appropriate values for testing the market price update scenario.

indexer/packages/postgres/__tests__/helpers/constants.ts (2)

749-749: LGTM! Appropriate exponent value for testing precision handling.

The change from -12 to -20 provides a good test case for very low exponent values, which is essential for verifying the fix for oracle price truncation.


Line range hint 1-1: Request: Please provide the production code changes.

The test changes look good and properly verify the handling of oracle prices with very low exponents. However, I don't see the actual implementation changes that fix the oracle price truncation issue. Could you please share the production code changes as well?

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@shrenujb shrenujb merged commit 56cc48e into main Jan 16, 2025
16 checks passed
@shrenujb shrenujb deleted the sbansal/oracle-price-fix branch January 16, 2025 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants