v1.5.11: active-orders endpoints [BAC-2110]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v3-client",
-  "version": "1.5.10",
+  "version": "1.5.11",
   "description": "Trading client library for the new dYdX system (v3 API)",
   "main": "build/src/index.js",
   "scripts": {

src/modules/private.ts

@@ -55,6 +55,7 @@ import {
   TransferParams,
   TransferResponseObject,
   UserResponseObject,
+  ActiveOrderResponseObject,
 } from '../types';
 import Clock from './clock';
 
@@ -360,6 +361,33 @@ export default class Private {
     );
   }
 
+  /**
+   * @description get active orders (PENDING, OPEN, UNTRIGGERED) for a user by a set of query
+   * parameters - if id is included then side is required
+   *
+   * @param {
+   * @market the orders are for
+   * @side of the book the orders are on
+   * @id of the order
+   * }
+   */
+  async getActiveOrders(
+    market: Market,
+    side?: OrderSide,
+    id?: string,
+    genericParams: GenericParams = {},
+  ): Promise<{ orders: ActiveOrderResponseObject[] }> {
+    return this._get(
+      'active-orders',
+      {
+        market,
+        side,
+        id,
+        ...genericParams,
+      },
+    );
+  }
+
   /**
    * @description get an order by a unique id
    *
@@ -471,6 +499,33 @@ export default class Private {
     );
   }
 
+  /**
+   * @description cancel active orders (PENDING, OPEN, UNTRIGGERED) for a user by a set of query
+   * parameters - if id is included then side is required
+   *
+   * @param {
+   * @market the orders are for
+   * @side of the book the orders are on
+   * @id of the order
+   * }
+   */
+  async cancelActiveOrders(
+    market: Market,
+    side?: OrderSide,
+    id?: string,
+    genericParams: GenericParams = {},
+  ): Promise<{ cancelOrders: ActiveOrderResponseObject[] }> {
+    return this.delete(
+      'active-orders',
+      {
+        market,
+        side,
+        id,
+        ...genericParams,
+      },
+    );
+  }
+
   /**
    *@description get fills for a user by a set of query parameters
    *

src/types.ts

@@ -251,6 +251,15 @@ export interface OrderResponseObject {
   cancelReason?: string | null;
 }
 
+export interface ActiveOrderResponseObject {
+  id: string;
+  accountId: string;
+  remainingSize: string;
+  price: string;
+  market: Market;
+  side: OrderSide;
+}
+
 export interface PositionResponseObject {
   market: Market;
   status: PositionStatus;