[CT-712] send order update when short term order state fill amounts a…

[jayy04]

…re pruned

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

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.

[linear]

CT-712 Send order updates in prepare check state for reverted local operations

[coderabbitai]

Walkthrough

The recent update introduces a synchronization between state fill amount pruning and order pruning within the PruneStateFillAmountsForShortTermOrders function. This enhancement ensures that orderbook updates are dispatched for orders that have been pruned, maintaining consistency across the system's order management and state tracking mechanisms.

Changes

File Path	Change Summary
protocol/x/clob/keeper/order_state.go	Updated the PruneStateFillAmountsForShortTermOrders function to dispatch orderbook updates for pruned orders, ensuring synchronization between state fill amount pruning and order pruning.

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 82c2dec and ac31868.

Files selected for processing (1)

• protocol/x/clob/keeper/order_state.go (1 hunks)

Additional comments: 1

protocol/x/clob/keeper/order_state.go (1)

• 261-278: The changes from lines 261 to 278 in the PruneStateFillAmountsForShortTermOrders function introduce logic to send orderbook updates for each pruned order. This is a crucial update for ensuring that the orderbook remains in sync with the state fill amount pruning process. Here are a few observations and suggestions:

1. Error Handling: It's important to ensure robust error handling around the new logic, especially when interacting with external systems or components like the gRPC streaming manager and the memClob. Consider adding error handling around critical operations that could fail, such as fetching orderbook updates or sending these updates.

2. Performance Considerations: The loop iterating over prunedOrderIds and generating orderbook updates for each could potentially become a performance bottleneck, especially if the number of pruned orders is large. It might be beneficial to assess the performance impact of this change, especially under high load, and consider optimizations if necessary.

3. Maintainability and Future Work: The TODO comment on line 268 mentions a long-term fix to add logic to keep state fill amount pruning and order pruning in sync. It's good practice to track such TODOs in a project management tool or issue tracker to ensure they are addressed in a timely manner. Additionally, consider documenting the current workaround and its implications for future maintainers.

4. Testing: Ensure comprehensive testing around this new functionality, including unit tests for the PruneStateFillAmountsForShortTermOrders function that cover various scenarios, such as when the gRPC streaming manager is enabled/disabled, and integration tests that simulate the pruning process and verify that orderbook updates are correctly sent and processed.

Overall, the changes align well with the PR's objectives to enhance synchronization between state fill amount pruning and order pruning processes. However, addressing the above considerations will further improve the robustness and maintainability of the implementation.

[jonfung-dydx]

ok if i'm understanding properly:

• place short term order A gtb 20
• fill 1 is created and expires at 20
• replace short term order A' gtb 23
• fill 2 is created and expires at 23
  [fill 1 is pruned at 20, fill 2 pruned at 23, and st order is pruned at 23]

and this will basically send an orderbook update indicating the order has 0 fill since it's been pruned?