BE-594/domain/slices | Slices package

[deividaspetraitis]

This PR was opened as part of bigger claimbot feature to keep PRs small, focused and more manageable and implements slices package containing various helper functions for manipulating slices. Slices pacakge is directly used by claimbot plugin to split claim orders into chunks of predined size ( maximum of 100 defined by the contract ).

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced OrderBookClaimerPlugin for enhanced order book processing.
  • Added CreateFormattedLimitOrder method to streamline order creation.
  • New utility function Split for slice manipulation.

• Improvements

  • Updated configuration to enable OrderBookClaimerPlugin.
  • Enhanced error handling and parameter naming for clarity in order processing methods.

• Bug Fixes

  • Resolved type inconsistencies in order handling across various components.

• Documentation

  • Added comments for clarity in method functionalities and struct fields.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request introduce the OrderBookClaimerPlugin into the ingest server, allowing it to process end-block events. Modifications include updates to configuration files to enable the new plugin, adjustments to method signatures across various files to accommodate new and altered types, and the addition of utility functions for slice manipulation. The integration enhances the overall functionality while maintaining existing logic for the OrderBookPlugin.

Changes

File Path	Change Summary
app/sidecar_query_server.go	Added import for orderbookclaimer, integrated OrderBookClaimerPlugin into NewSideCarQueryServer.
domain/config.go	Updated GRPCIngesterConfig to enable OrderBookClaimerPlugin.
domain/mvc/orderbook.go	Added method CreateFormattedLimitOrder to OrderBookUsecase interface.
domain/orderbook/grpcclient/orderbook_grpc_client.go	Updated GetOrdersByTick return type from orderbookplugindomain.Order to orderbookdomain.Orders.
domain/orderbook/grpcclient/orderbook_query_payloads.go	Updated response structs to use orderbookdomain types instead of orderbookplugindomain.
domain/orderbook/order.go	Added method OrderByDirection to filter orders by direction.
domain/orderbook/orderbook_repository.go	Added comment to GetAllTicks method in OrderBookRepository interface.
domain/orderbook/orderbook_tick.go	Added comments to fields in TickValues struct.
domain/orderbook/plugin/config.go	Added constant OrderBookClaimerPluginName and updated formatting for OrderBookPluginName.
domain/orderbook/plugin/orderbook_grpc_client.go	Updated GetOrdersByTick return type to orderbookdomain.Orders.
domain/orderbook/plugin/orderbook_order.go	Removed Order struct from orderbookplugindomain, updated OrdersResponse to use orderbookdomain.Order.
domain/slices/slices.go	Introduced Split function for slice manipulation.
ingest/usecase/plugins/orderbookfiller/fillable_orders.go	Updated method signatures to use orderbookdomain.Order.
ingest/usecase/plugins/orderbookfiller/tick_fetcher.go	Updated variable types in fetchTicksForOrderbook method to orderbookdomain.Order.
orderbook/usecase/orderbook_usecase.go	Renamed parameters and updated method signatures for clarity and consistency.

Possibly related PRs

• SQS-412 | Active Orders Query: SSE #518: Changes in app/sidecar_query_server.go related to adding a logger parameter, relevant to the integration of the OrderBookClaimerPlugin.
• [Q3] Auto-update asset list at regular intervals #375: Modifications in app/sidecar_query_server.go regarding the initialization of tokensUseCase, potentially related to overall functionality enhancements.
• refactor: introduce candidate route optimization to prices #372: Restructuring of the sideCarQueryServer struct in app/sidecar_query_server.go, relevant to plugin integration and server functionality.

Suggested reviewers

• p0mvn
• PaddyMc

Poem

In the garden where plugins play,
A Claimer hops in, brightening the day.
With orders aligned, and slices to share,
The server now dances, with joy in the air!
So let us rejoice, in this code we adore,
For bunnies and plugins, there’s always more! 🐇✨

---

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

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.