SQS Ingester: Add Orderbook amount in to exhaust liquidity

[iboss-ptk]

What is the purpose of the change

Precompute and ingest BidAmountToExhaustAskLiquidity & AskAmountToExhaustBidLiquidity through OrderbookData. This reduces the need to iterate all the ticks if the requested amount in is over these threshold based on order direction.

Testing and Verifying

• unit tested for updateOrderbookInfo function
• more comprehensive test cases for calculation are already covered in sqsdomain

[coderabbitai[bot]]

Walkthrough

This update enhances the ingest/sqs module by incorporating calculations for bid and ask amounts to exhaust liquidity within the OrderbookData structure. This functionality is implemented in the updateOrderbookInfo method of the poolTransformer struct. Corresponding updates to tests ensure that these new fields are covered. The result is an enriched dataset for order book analysis, improving liquidity tracking.

Changes

File Path	Change Summary
ingest/sqs/CHANGELOG.md	Added a note about the new feature for order book exhaustion calculations as per pull request #8458.
ingest/sqs/pools/transformer/orderbook.go	Updated updateOrderbookInfo to include bid/ask amounts to exhaust liquidity in OrderbookData.
ingest/sqs/pools/transformer/orderbook_test.go	Added constants and test cases to validate the bid/ask liquidity exhaustion calculations within OrderbookData.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant SQSModule as SQS Module
    participant PoolTransformer as Pool Transformer
    participant OrderbookData

    Client->>SQSModule: Request to update order book info
    SQSModule->>PoolTransformer: Call updateOrderbookInfo
    PoolTransformer->>OrderbookData: Compute bid/ask amounts to exhaust liquidity
    OrderbookData-->>PoolTransformer: Return updated OrderbookData
    PoolTransformer-->>SQSModule: Return with updated OrderbookData
    SQSModule-->>Client: Response with updated order book info

---

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