[Orderbook] Make the trigger condition more generic (#17197)

sitalkedia · web-flow · commit 3c53773536b6 · 2025-07-31T16:15:36.000Z
diff --git a/aptos-move/framework/aptos-experimental/doc/order_book.md b/aptos-move/framework/aptos-experimental/doc/order_book.md
@@ -535,12 +535,12 @@ If order doesn't exist, it aborts with EORDER_NOT_FOUND.
             _bid_price,
             _orig_size,
             _size,
-            is_bid,
+            _is_bid,
             trigger_condition,
             _
         ) = order.destroy_order();
         self.pending_orders.cancel_pending_order(
-            trigger_condition.destroy_some(), unique_priority_idx, is_bid
+            trigger_condition.destroy_some(), unique_priority_idx
         );
         <b>if</b> (client_order_id.is_some()) {
             self.client_order_ids.remove(
@@ -912,7 +912,6 @@ it is added to the order book, if it exists, it's size is updated.
         order_id,
         order_req.trigger_condition.destroy_some(),
         ascending_idx,
-        order_req.is_bid
     );
 }
 </code></pre>
diff --git a/aptos-move/framework/aptos-experimental/doc/order_book_types.md b/aptos-move/framework/aptos-experimental/doc/order_book_types.md
@@ -32,8 +32,8 @@
 -  [Function `get_active_matched_size`](#0x7_order_book_types_get_active_matched_size)
 -  [Function `get_matched_size`](#0x7_order_book_types_get_matched_size)
 -  [Function `new_order_with_state`](#0x7_order_book_types_new_order_with_state)
--  [Function `tp_trigger_condition`](#0x7_order_book_types_tp_trigger_condition)
--  [Function `sl_trigger_condition`](#0x7_order_book_types_sl_trigger_condition)
+-  [Function `price_move_up_condition`](#0x7_order_book_types_price_move_up_condition)
+-  [Function `price_move_down_condition`](#0x7_order_book_types_price_move_down_condition)
 -  [Function `index`](#0x7_order_book_types_index)
 -  [Function `get_order_from_state`](#0x7_order_book_types_get_order_from_state)
 -  [Function `get_metadata_from_state`](#0x7_order_book_types_get_metadata_from_state)
@@ -386,7 +386,7 @@
 
 
 <details>
-<summary>TakeProfit</summary>
+<summary>PriceMoveAbove</summary>
 
 
 <details>
@@ -408,7 +408,7 @@
 </details>
 
 <details>
-<summary>StopLoss</summary>
+<summary>PriceMoveBelow</summary>
 
 
 <details>
@@ -998,13 +998,13 @@
 
 </details>
 
-<a id="0x7_order_book_types_tp_trigger_condition"></a>
+<a id="0x7_order_book_types_price_move_up_condition"></a>
 
-## Function `tp_trigger_condition`
+## Function `price_move_up_condition`
 
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_tp_trigger_condition">tp_trigger_condition</a>(take_profit: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>
+<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_price_move_up_condition">price_move_up_condition</a>(price: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>
 </code></pre>
 
 
@@ -1013,22 +1013,22 @@
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_tp_trigger_condition">tp_trigger_condition</a>(take_profit: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">TriggerCondition</a> {
-    TriggerCondition::TakeProfit(take_profit)
+<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_price_move_up_condition">price_move_up_condition</a>(price: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">TriggerCondition</a> {
+    TriggerCondition::PriceMoveAbove(price)
 }
 </code></pre>
 
 
 
 </details>
 
-<a id="0x7_order_book_types_sl_trigger_condition"></a>
+<a id="0x7_order_book_types_price_move_down_condition"></a>
 
-## Function `sl_trigger_condition`
+## Function `price_move_down_condition`
 
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_sl_trigger_condition">sl_trigger_condition</a>(stop_loss: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>
+<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_price_move_down_condition">price_move_down_condition</a>(price: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>
 </code></pre>
 
 
@@ -1037,8 +1037,8 @@
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_sl_trigger_condition">sl_trigger_condition</a>(stop_loss: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">TriggerCondition</a> {
-    TriggerCondition::StopLoss(stop_loss)
+<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_price_move_down_condition">price_move_down_condition</a>(price: u64): <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">TriggerCondition</a> {
+    TriggerCondition::PriceMoveBelow(price)
 }
 </code></pre>
 
@@ -1052,7 +1052,7 @@
 
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_index">index</a>(self: &<a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>, is_bid: bool): (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a>&lt;u64&gt;, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a>&lt;u64&gt;, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a>&lt;u64&gt;)
+<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_index">index</a>(self: &<a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>): (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a>&lt;u64&gt;, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a>&lt;u64&gt;, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a>&lt;u64&gt;)
 </code></pre>
 
 
@@ -1061,22 +1061,14 @@
 <summary>Implementation</summary>
 
 
-<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_index">index</a>(self: &<a href="order_book_types.md#0x7_order_book_types_TriggerCondition">TriggerCondition</a>, is_bid: bool):
+<pre><code><b>public</b> <b>fun</b> <a href="order_book_types.md#0x7_order_book_types_index">index</a>(self: &<a href="order_book_types.md#0x7_order_book_types_TriggerCondition">TriggerCondition</a>):
     (Option&lt;u64&gt;, Option&lt;u64&gt;, Option&lt;u64&gt;) {
     match(self) {
-        TriggerCondition::TakeProfit(tp) =&gt; {
-            <b>if</b> (is_bid) {
-                (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(*tp), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>())
-            } <b>else</b> {
-                (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(*tp), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>())
-            }
+        TriggerCondition::PriceMoveAbove(price) =&gt; {
+            (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(*price), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>())
         }
-        TriggerCondition::StopLoss(sl) =&gt; {
-            <b>if</b> (is_bid) {
-                (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(*sl), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>())
-            } <b>else</b> {
-                (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(*sl), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>())
-            }
+        TriggerCondition::PriceMoveBelow(price) =&gt; {
+            (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(*price), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>())
         }
         TriggerCondition::TimeBased(time) =&gt; {
             (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(*time))
diff --git a/aptos-move/framework/aptos-experimental/doc/pending_order_book_index.md b/aptos-move/framework/aptos-experimental/doc/pending_order_book_index.md
@@ -141,7 +141,7 @@
 
 
 
-<pre><code><b>public</b>(<b>friend</b>) <b>fun</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_cancel_pending_order">cancel_pending_order</a>(self: &<b>mut</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_PendingOrderBookIndex">pending_order_book_index::PendingOrderBookIndex</a>, trigger_condition: <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>, unique_priority_idx: <a href="order_book_types.md#0x7_order_book_types_UniqueIdxType">order_book_types::UniqueIdxType</a>, is_bid: bool)
+<pre><code><b>public</b>(<b>friend</b>) <b>fun</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_cancel_pending_order">cancel_pending_order</a>(self: &<b>mut</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_PendingOrderBookIndex">pending_order_book_index::PendingOrderBookIndex</a>, trigger_condition: <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>, unique_priority_idx: <a href="order_book_types.md#0x7_order_book_types_UniqueIdxType">order_book_types::UniqueIdxType</a>)
 </code></pre>
 
 
@@ -154,10 +154,9 @@
     self: &<b>mut</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_PendingOrderBookIndex">PendingOrderBookIndex</a>,
     trigger_condition: TriggerCondition,
     unique_priority_idx: UniqueIdxType,
-    is_bid: bool
 ) {
     <b>let</b> (price_move_up_index, price_move_down_index, time_based_index) =
-        trigger_condition.index(is_bid);
+        trigger_condition.index();
     <b>if</b> (price_move_up_index.is_some()) {
         self.price_move_up_index.remove(
             &<a href="pending_order_book_index.md#0x7_pending_order_book_index_PendingOrderKey">PendingOrderKey</a> {
@@ -190,7 +189,7 @@
 
 
 
-<pre><code><b>public</b>(<b>friend</b>) <b>fun</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_place_pending_maker_order">place_pending_maker_order</a>(self: &<b>mut</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_PendingOrderBookIndex">pending_order_book_index::PendingOrderBookIndex</a>, order_id: <a href="order_book_types.md#0x7_order_book_types_OrderIdType">order_book_types::OrderIdType</a>, trigger_condition: <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>, unique_priority_idx: <a href="order_book_types.md#0x7_order_book_types_UniqueIdxType">order_book_types::UniqueIdxType</a>, is_bid: bool)
+<pre><code><b>public</b>(<b>friend</b>) <b>fun</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_place_pending_maker_order">place_pending_maker_order</a>(self: &<b>mut</b> <a href="pending_order_book_index.md#0x7_pending_order_book_index_PendingOrderBookIndex">pending_order_book_index::PendingOrderBookIndex</a>, order_id: <a href="order_book_types.md#0x7_order_book_types_OrderIdType">order_book_types::OrderIdType</a>, trigger_condition: <a href="order_book_types.md#0x7_order_book_types_TriggerCondition">order_book_types::TriggerCondition</a>, unique_priority_idx: <a href="order_book_types.md#0x7_order_book_types_UniqueIdxType">order_book_types::UniqueIdxType</a>)
 </code></pre>
 
 
@@ -204,12 +203,10 @@
     order_id: OrderIdType,
     trigger_condition: TriggerCondition,
     unique_priority_idx: UniqueIdxType,
-    is_bid: bool
 ) {
     // Add this order <b>to</b> the pending order book index
     <b>let</b> (price_move_down_index, price_move_up_index, time_based_index) =
-        trigger_condition.index(is_bid);
-
+        trigger_condition.index();
     <b>if</b> (price_move_up_index.is_some()) {
         self.price_move_up_index.add(
             <a href="pending_order_book_index.md#0x7_pending_order_book_index_PendingOrderKey">PendingOrderKey</a> {
diff --git a/aptos-move/framework/aptos-experimental/sources/trading/order_book/order_book.move b/aptos-move/framework/aptos-experimental/sources/trading/order_book/order_book.move
@@ -40,8 +40,8 @@ module aptos_experimental::order_book {
     #[test_only]
     use aptos_experimental::order_book_types::{
         new_order_id_type,
-        tp_trigger_condition,
-        UniqueIdxType
+        price_move_up_condition,
+        UniqueIdxType, price_move_down_condition
     };
 
     const EORDER_ALREADY_EXISTS: u64 = 1;
@@ -157,12 +157,12 @@ module aptos_experimental::order_book {
                 _bid_price,
                 _orig_size,
                 _size,
-                is_bid,
+                _is_bid,
                 trigger_condition,
                 _
             ) = order.destroy_order();
             self.pending_orders.cancel_pending_order(
-                trigger_condition.destroy_some(), unique_priority_idx, is_bid
+                trigger_condition.destroy_some(), unique_priority_idx
             );
             if (client_order_id.is_some()) {
                 self.client_order_ids.remove(
@@ -356,7 +356,6 @@ module aptos_experimental::order_book {
             order_id,
             order_req.trigger_condition.destroy_some(),
             ascending_idx,
-            order_req.is_bid
         );
     }
 
@@ -1116,7 +1115,7 @@ module aptos_experimental::order_book {
     }
 
     #[test]
-    fun test_TP_order() {
+    fun test_price_move_down_condition() {
         let order_book = new_order_book<TestMetadata>();
 
         // Place a GTC sell order for 1000 units at price 100
@@ -1149,7 +1148,7 @@ module aptos_experimental::order_book {
                     orig_size: 400,
                     remaining_size: 400,
                     is_bid: true,
-                    trigger_condition: option::some(tp_trigger_condition(90)),
+                    trigger_condition: option::some(price_move_down_condition(90)),
                     metadata: TestMetadata {}
                 }
             );
@@ -1175,64 +1174,11 @@ module aptos_experimental::order_book {
         assert!(matched_size == 400);
         assert!(order.get_orig_size() == 1000);
         assert!(order.get_remaining_size() == 600); // Partial fill
-
-        // Place another buy order for 300 units
-        let match_result =
-            order_book.place_order_and_get_matches(
-                OrderRequest::V1 {
-                    account: @0xBB,
-                    order_id: new_order_id_type(3),
-                    client_order_id: option::none(),
-                    price: 100,
-                    orig_size: 300,
-                    remaining_size: 300,
-                    is_bid: true,
-                    trigger_condition: option::some(tp_trigger_condition(80)),
-                    metadata: TestMetadata {}
-                }
-            );
-
-        assert!(match_result.is_empty());
-        assert!(
-            order_book.pending_orders.get_price_move_down_index().keys().length() == 1
-        );
-
-        // Oracle price moves up to 95, this should not trigger any order
-        let match_results = order_book.trigger_pending_orders(95);
-        assert!(match_results.length() == 0);
-
-        // Move the oracle price down to 80, this should trigger the order
-        let match_results = order_book.trigger_pending_orders(80);
-        // Verify second taker was fully filled
-        assert!(total_matched_size(&match_results) == 300);
-
-        // Verify original maker was partially filled again
-        assert!(match_results.length() == 1);
-        let maker_match = match_results[0];
-        let (order, matched_size) = maker_match.destroy_single_order_match();
-        assert!(order.get_account() == @0xAA);
-        assert!(order.get_order_id() == new_order_id_type(1));
-        assert!(matched_size == 300);
-        assert!(order.get_orig_size() == 1000);
-        assert!(order.get_remaining_size() == 300); // Still partial as 300 units remain
-
-        // Original sell order should still exist with 300 units remaining
-        let order_id = new_order_id_type(1);
-        let order_state = *order_book.orders.borrow(&order_id);
-        let (order, is_active) = order_state.destroy_order_from_state();
-        let (_account, _order_id, _, price, orig_size, size, is_bid, _, _) =
-            order.destroy_order();
-        assert!(is_active == true);
-        assert!(price == 100);
-        assert!(orig_size == 1000);
-        assert!(size == 300); // 1000 - 400 - 300 = 300 remaining
-        assert!(is_bid == false);
-
         order_book.destroy_order_book();
     }
 
     #[test]
-    fun test_SL_order() {
+    fun test_price_move_up_condition() {
         let order_book = new_order_book<TestMetadata>();
 
         // Place a GTC sell order for 1000 units at price 100
@@ -1265,7 +1211,7 @@ module aptos_experimental::order_book {
                     orig_size: 400,
                     remaining_size: 400,
                     is_bid: false,
-                    trigger_condition: option::some(tp_trigger_condition(110)),
+                    trigger_condition: option::some(price_move_up_condition(110)),
                     metadata: TestMetadata {}
                 }
             );
@@ -1304,7 +1250,7 @@ module aptos_experimental::order_book {
                     orig_size: 300,
                     remaining_size: 300,
                     is_bid: false,
-                    trigger_condition: option::some(tp_trigger_condition(120)),
+                    trigger_condition: option::some(price_move_up_condition(120)),
                     metadata: TestMetadata {}
                 }
             );
@@ -1519,7 +1465,7 @@ module aptos_experimental::order_book {
             orig_size: 1000,
             remaining_size: 1000,
             is_bid: false,
-            trigger_condition: option::some(tp_trigger_condition(90)),
+            trigger_condition: option::some(price_move_up_condition(90)),
             metadata: TestMetadata {}
         };
         order_book.place_maker_order(order_req);
diff --git a/aptos-move/framework/aptos-experimental/sources/trading/order_book/order_book_types.move b/aptos-move/framework/aptos-experimental/sources/trading/order_book/order_book_types.move
diff --git a/aptos-move/framework/aptos-experimental/sources/trading/order_book/pending_order_book_index.move b/aptos-move/framework/aptos-experimental/sources/trading/order_book/pending_order_book_index.move
