Merge pull request #394 from idexio/feat/add-conditional-order-props-…

…to-ws-api-types feat(conditional TP/SL orders): add order `subType` prop to WS API msgs
idexio · Nov 14, 2024 · 7180e59 · 7180e59
2 parents 404d549 + 571d999
commit 7180e59
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -129,7 +129,7 @@
     "bignumber.js": "^9.1.2",
     "ethers": "6.9.0",
     "isomorphic-ws": "^5.0.0",
-    "tslib": "^2.6.2",
+    "tslib": "^2.7.0",
     "uuid": "^9.0.1",
     "ws": "8.17.0"
   },

diff --git a/src/client/webSocket/transform.ts b/src/client/webSocket/transform.ts
@@ -169,6 +169,7 @@ function transformOrdersMessage(
     errorCode: short.ec,
     errorMessage: short.em,
     type: short.o,
+    subType: short.O,
     side: short.s,
     originalQuantity: short.q,
     executedQuantity: short.z,
@@ -178,7 +179,7 @@ function transformOrdersMessage(
     triggerPrice: short.P,
     triggerType: short.tt,
     // callbackRate: short.cr,
-    // conditionalOrderId: short.ci,
+    conditionalOrderId: short.ci,
     reduceOnly: short.r,
     timeInForce: short.f,
     selfTradePrevention: short.V,

diff --git a/src/types/enums/request.ts b/src/types/enums/request.ts
@@ -464,20 +464,22 @@ export const OrderType = Object.freeze({
    *    to provide inline IDE completion and documentation.
    */
   trailingStopMarket: 'trailingStopMarket',
-
-  /**
-   * @internal
-   */
-  conditionalStopLossMarket: 'conditionalStopLossMarket',
-
-  /**
-   * @internal
-   */
-  conditionalTakeProfitMarket: 'conditionalTakeProfitMarket',
 } as const);
 
 export type OrderType = (typeof OrderType)[keyof typeof OrderType];
 
+/**
+ * @internal
+ */
+export const OrderSubType = Object.freeze({
+  conditional: 'conditional',
+});
+
+/**
+ * @internal
+ */
+export type OrderSubType = (typeof OrderSubType)[keyof typeof OrderSubType];
+
 /**
  * @see request {@link _types.RestRequestOrderBase.side RestRequestOrder.side}
  * @see related {@link _types.IDEXOrder IDEXOrder Interface}

diff --git a/src/types/rest/endpoints/GetOrders.ts b/src/types/rest/endpoints/GetOrders.ts
@@ -141,6 +141,7 @@ export interface IDEXOrder {
    * - Only applicable to stop {@link OrderType order types}:
    *   - {@link OrderType.stopLossMarket stopLossMarket}
    *   - {@link OrderType.stopLossLimit stopLossLimit}
+   *   - {@link OrderType.takeProfitMarket takeProfitMarket}
    *   - {@link OrderType.trailingStopMarket trailingStopMarket}
    * - Indicates an {@link orderId} of an open {@link OrderType.limit limit} order
    *   by the same wallet in the same market that must be filled before the stop becomes active.

diff --git a/src/types/webSocket/response/orders.ts b/src/types/webSocket/response/orders.ts
@@ -1,5 +1,9 @@
 import type * as idex from '#index';
-import type { MessageEventType, OrderType } from '#types/enums/index';
+import type {
+  MessageEventType,
+  OrderSubType,
+  OrderType,
+} from '#types/enums/index';
 import type { OrderStateChange } from '#types/enums/response';
 import type { IDEXOrder } from '#types/rest/endpoints/GetOrders';
 import type { IDEXSubscriptionEventBase } from '#types/webSocket/base';
@@ -101,6 +105,10 @@ export interface IDEXOrderEventDataGeneral
    * @inheritDoc
    */
   readonly type: OrderType;
+  /**
+   * @internal
+   */
+  readonly subType?: OrderSubType;
   /**
    * Type of order update
    *
@@ -181,7 +189,6 @@ export interface WebSocketResponseOrderShortBase {
    * @see inflated {@link IDEXOrderEventDataGeneral.wallet}
    */
   w: IDEXOrderEventDataBase['wallet'];
-  // t: IDEXOrder['execut'];
   /**
    * @see inflated {@link IDEXOrderEventDataGeneral.executionTime}
    */
@@ -229,6 +236,10 @@ export interface WebSocketResponseOrderShortGeneral
    * @inheritDoc
    */
   o: IDEXOrderEventDataGeneral['type'];
+  /**
+   * @internal
+   */
+  O?: IDEXOrderEventDataGeneral['subType'];
   /**
    * @see related {@link IDEXOrder.orderId}
    * @see inflated {@link IDEXOrderEventDataGeneral.orderId}
@@ -314,7 +325,7 @@ export interface WebSocketResponseOrderShortGeneral
   /**
    * @see inflated {@link IDEXOrderEventDataGeneral.conditionalOrderId}
    */
-  ci?: string;
+  ci?: IDEXOrderEventDataGeneral['conditionalOrderId'];
   /**
    * @see related {@link IDEXOrder.reduceOnly}
    * @see inflated {@link IDEXOrderEventDataGeneral.reduceOnly}

diff --git a/yarn.lock b/yarn.lock
@@ -626,7 +626,7 @@ __metadata:
     semantic-release: "npm:^23.1.1"
     semantic-release-slack-bot: "npm:^4.0.2"
     slackify-markdown: "npm:^4.4.0"
-    tslib: "npm:^2.6.2"
+    tslib: "npm:^2.7.0"
     tsx: "npm:^4.10.2"
     typedoc: "npm:0.25.13"
     typedoc-plugin-extras: "npm:^3.0.0"
@@ -11194,6 +11194,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"tslib@npm:^2.7.0":
+  version: 2.8.1
+  resolution: "tslib@npm:2.8.1"
+  checksum: 10c0/9c4759110a19c53f992d9aae23aac5ced636e99887b51b9e61def52611732872ff7668757d4e4c61f19691e36f4da981cd9485e869b4a7408d689f6bf1f14e62
+  languageName: node
+  linkType: hard
+
 "tsx@npm:^4.10.2":
   version: 4.10.2
   resolution: "tsx@npm:4.10.2"