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

Increase conditional order trigger multiplier to 25 #1460

Merged
merged 1 commit into from
May 3, 2024
Merged

Conversation

jayy04
Copy link
Contributor

@jayy04 jayy04 commented May 3, 2024

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.

Summary by CodeRabbit

  • New Features

    • Introduced new order types for buying and selling BTC with specific conditions and prices for users Carl, Dave, Alice, and Bob.
    • Enhanced trading strategies with the addition of conditional orders that include take-profit and stop-loss options.
  • Refactor

    • Adjusted the multiplier for conditional order triggers, enhancing the precision of trading strategies.

Copy link

coderabbitai bot commented May 3, 2024

Walkthrough

The recent updates involve the introduction of new standard and conditional orders for trading BTC, targeting specific prices and conditions, and an adjustment in the multiplier affecting conditional order triggers. These changes enhance the flexibility and precision in order execution for clients like Carl, Dave, Alice, and Bob within the trading protocol.

Changes

File Path Change Summary
.../constants/orders.go Added new order declarations for Carl and Dave to buy and sell BTC at specified prices and conditions.
.../constants/stateful_orders.go Introduced new conditional orders for Alice and Bob with specific price targets and stop losses.
.../clob/e2e/conditional_orders_test.go Integrated the newly declared orders and conditional orders in end-to-end tests to ensure functionality aligns with trading scenarios for Alice, Bob, Carl, and Dave.
.../clob/types/constants.go Modified the ConditionalOrderTriggerMultiplier value from 5 to 25, impacting the calculation of the lower bound for conditional orders, thus adjusting the sensitivity and response of these orders under varying market conditions.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between fb6c113 and f2376b9.
Files selected for processing (4)
  • protocol/testutil/constants/orders.go (2 hunks)
  • protocol/testutil/constants/stateful_orders.go (3 hunks)
  • protocol/x/clob/e2e/conditional_orders_test.go (4 hunks)
  • protocol/x/clob/types/constants.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • protocol/x/clob/types/constants.go
Additional Context Used
Path-based Instructions (3)
protocol/testutil/constants/stateful_orders.go (1)

Pattern **/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

protocol/testutil/constants/orders.go (1)

Pattern **/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

protocol/x/clob/e2e/conditional_orders_test.go (1)

Pattern **/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

Additional comments not posted (7)
protocol/testutil/constants/stateful_orders.go (4)

889-902: The addition of ConditionalOrder_Alice_Num0_Id0_Clob0_Buy1BTC_Price50000_GTBT10_TP_48700 introduces a new conditional order with a take-profit condition. The order is well-formed with all necessary fields correctly initialized. This aligns with the PR's objective to enhance conditional order functionalities.


1017-1029: The addition of ConditionalOrder_Alice_Num0_Id0_Clob0_Buy1BTC_Price50000_GTBT10_SL_51300 introduces a new stop-loss condition for Alice's order. It's crucial to ensure that the trigger subticks value (51_300_000_000) aligns with the intended market strategy and risk management protocols. This should be verified with the trading strategy team.


1073-1085: The addition of ConditionalOrder_Bob_Num0_Id0_Clob0_Sell1BTC_Price50000_GTBT10_TP_51300 introduces a new take-profit condition for Bob's order. It's important to ensure that the conditional trigger subticks value (51_300_000_000) is consistent with the market conditions expected during the order's lifetime. This should be validated against historical market data.


1087-1099: The addition of ConditionalOrder_Bob_Num0_Id0_Clob0_Sell1BTC_Price50000_GTBT10_SL_48700 introduces a new stop-loss condition for Bob's order. This change is part of the broader strategy to enhance risk management in trading operations. Ensure that the subticks value (48_700_000_000) is set based on a thorough risk assessment.

protocol/testutil/constants/orders.go (2)

935-941: The new order for Carl is correctly declared and follows the existing pattern of order declarations.


1097-1103: The new order for Dave is correctly declared and follows the existing pattern of order declarations.

protocol/x/clob/e2e/conditional_orders_test.go (1)

Line range hint 14-1287: Comprehensive testing of conditional orders.


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

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

@jayy04
Copy link
Contributor Author

jayy04 commented May 3, 2024

@Mergifyio backport release/protocol/v5.x

Copy link

mergify bot commented May 3, 2024

backport release/protocol/v5.x

✅ Backports have been created

@jayy04 jayy04 merged commit 25dbefe into main May 3, 2024
17 checks passed
@jayy04 jayy04 deleted the jy/5x-trigger branch May 3, 2024 14:40
mergify bot pushed a commit that referenced this pull request May 3, 2024
jayy04 added a commit that referenced this pull request May 3, 2024
(cherry picked from commit 25dbefe)

Co-authored-by: jayy04 <103467857+jayy04@users.noreply.github.com>
jayy04 added a commit that referenced this pull request Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants