search

dydxprotocol / v4-chain

dydx v4 protocol
Other
231 stars 105 forks source link

Add missing fields to perpetual markets kafka update #2539

Closed shrenujb closed 2 weeks ago

shrenujb commented 2 weeks ago

Changelist

Add additional fields to the perpetual markets updates needed by the websocket message to the FE

Test Plan

Existing tests

Author/Reviewer Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve updates to the TradingPerpetualMarketMessage interface and the generatePerpetualMarketMessage function within the codebase. Two optional properties, tickSize and stepSize, have been added to the interface, enhancing the data structure for market trading parameters. Additionally, the generatePerpetualMarketMessage function has been modified to include several new properties, allowing for more detailed information to be conveyed in the perpetual market messages.

Changes

File Path Change Summary
indexer/packages/postgres/src/types/websocket-message-types.ts Added optional properties tickSize?: string and stepSize?: string to the TradingPerpetualMarketMessage interface.
indexer/services/ender/src/helpers/kafka-helper.ts Added import for protocolTranslations and expanded generatePerpetualMarketMessage to include new properties: marketType, tickSize, stepSize, priceChange24H, volume24H, trades24H, nextFundingRate, openInterest, and baseOpenInterest.

Possibly related PRs

Suggested reviewers

🐇 In the market where rabbits play,
New fields have come to brighten the day.
Tick sizes and steps, oh what a treat,
For trading messages, they can't be beat!
With each hop, the data flows,
In the world of trading, excitement grows! 🐇

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.
shrenujb commented 2 weeks ago

@mergifyio release/indexer/v7.x

mergify[bot] commented 2 weeks ago

release /indexer/v7.x

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

shrenujb commented 2 weeks ago

@mergifyio backport release/indexer/v7.x

mergify[bot] commented 2 weeks ago

backport release/indexer/v7.x

✅ Backports have been created

* [#2542 Add missing fields to perpetual markets kafka update (backport #2539)](https://github.com/dydxprotocol/v4-chain/pull/2542) has been created for branch `release/indexer/v7.x`