feat(): add amend keep priority wsapi, breaking change: rename amend/keep priority response interface

Author: tiagosiebler

src/main-client.ts

@@ -434,7 +434,7 @@ import {
   SpecialLowLatencyKeyInfo,
   SpecialLowLatencyKeyResponse,
   SpotAlgoOrder,
-  SpotAmendKeepPriority,
+  SpotAmendKeepPriorityResult,
   SpotOrder,
   StakingBasicParams,
   StakingHistory,
@@ -853,7 +853,7 @@ export class MainClient extends BaseRestClient {
    */
   amendOrderKeepPriority(
     params: AmendKeepPriorityParams,
-  ): Promise<SpotAmendKeepPriority> {
+  ): Promise<SpotAmendKeepPriorityResult> {
     this.validateOrderId(params, 'newClientOrderId');
     return this.putPrivate('fapi/v1/order/amend/keepPriority', params);
   }

src/types/spot.ts

@@ -886,7 +886,7 @@ export interface SpotOrder {
   selfTradePreventionMode: SelfTradePreventionMode;
 }
 
-export interface SpotAmendKeepPriority {
+export interface SpotAmendKeepPriorityResult {
   transactTime: number;
   executionId: number;
   amendedOrder: {

src/types/websockets/ws-api-requests.ts

@@ -273,6 +273,16 @@ export interface WSAPIOrderCancelReplaceRequest {
   timestamp?: number;
 }
 
+export interface WSAPIOrderAmendKeepPriorityRequest {
+  symbol: string;
+  orderId?: number | string;
+  origClientOrderId?: string;
+  newClientOrderId?: string;
+  newQty?: string;
+  recvWindow?: number;
+  timestamp: number;
+}
+
 export interface WSAPIOpenOrdersStatusRequest {
   symbol?: string;
   recvWindow?: number;

src/types/websockets/ws-api.ts

@@ -20,6 +20,7 @@ import {
   WSAPIMyTradesRequest,
   WSAPIOpenOrdersCancelAllRequest,
   WSAPIOpenOrdersStatusRequest,
+  WSAPIOrderAmendKeepPriorityRequest,
   WSAPIOrderBookRequest,
   WSAPIOrderCancelReplaceRequest,
   WSAPIOrderCancelRequest,
@@ -138,6 +139,7 @@ export const WS_API_Operations = [
   'order.status',
   'order.cancel',
   'order.cancelReplace',
+  'order.amend.keepPriority',
   'order.modify',
   'openOrders.status',
   'openOrders.cancelAll',
@@ -359,8 +361,9 @@ export interface WsAPITopicRequestParamMap<TWSKey = WsKey> {
     ? WSAPIFuturesOrderCancelRequest
     : WSAPIOrderCancelRequest;
   'order.modify': WSAPIFuturesOrderModifyRequest; // order.modify only futures
-  'order.cancelReplace': WSAPIOrderCancelReplaceRequest;
 
+  'order.cancelReplace': WSAPIOrderCancelReplaceRequest;
+  'order.amend.keepPriority': WSAPIOrderAmendKeepPriorityRequest;
   'openOrders.status': WSAPIOpenOrdersStatusRequest;
   'openOrders.cancelAll': WSAPIOpenOrdersCancelAllRequest;
 

src/util/requestUtils.ts

@@ -5,6 +5,7 @@ import { BinanceBaseUrlKey, OrderIdProperty } from '../types/shared';
 import { WsRequestOperationBinance } from '../types/websockets/ws-api';
 import { USDMClient } from '../usdm-client';
 import { signMessage } from './node-support';
+import { neverGuard } from './typeGuards';
 import { SignAlgorithm, SignEncodeMethod } from './webCryptoAPI';
 import {
   parseEventTypeFromMessage,
@@ -175,19 +176,37 @@ export function requiresWSAPINewClientOID(
     case WS_KEY_MAP.mainWSAPI2:
     case WS_KEY_MAP.mainWSAPITestnet:
     case WS_KEY_MAP.usdmWSAPI:
-    case WS_KEY_MAP.usdmWSAPITestnet: {
+    case WS_KEY_MAP.usdmWSAPITestnet:
+    case WS_KEY_MAP.coinmWSAPI:
+    case WS_KEY_MAP.coinmWSAPITestnet: {
       switch (request.method) {
-        case 'order.place': {
+        case 'order.place':
+        case 'order.amend.keepPriority': {
           return true;
         }
         default: {
           return false;
         }
       }
     }
+    case WS_KEY_MAP.main:
+    case WS_KEY_MAP.main2:
+    case WS_KEY_MAP.main3:
+    case WS_KEY_MAP.mainTestnetPublic:
+    case WS_KEY_MAP.mainTestnetUserData:
+    case WS_KEY_MAP.marginRiskUserData:
+    case WS_KEY_MAP.usdm:
+    case WS_KEY_MAP.usdmTestnet:
+    case WS_KEY_MAP.coinm:
+    case WS_KEY_MAP.coinm2:
+    case WS_KEY_MAP.coinmTestnet:
+    case WS_KEY_MAP.eoptions:
+    case WS_KEY_MAP.portfolioMarginUserData:
+    case WS_KEY_MAP.portfolioMarginProUserData:
+      return false;
 
     default: {
-      return false;
+      throw neverGuard(wsKey, `Unhandled WsKey "${wsKey}"`);
     }
   }
 }

src/websocket-api-client.ts

@@ -1,4 +1,8 @@
-import { ExchangeInfo, OrderResponse } from './types/spot';
+import {
+  ExchangeInfo,
+  OrderResponse,
+  SpotAmendKeepPriorityResult,
+} from './types/spot';
 import {
   WSAPIResponse,
   WSAPIUserDataListenKeyRequest,
@@ -26,6 +30,7 @@ import {
   WSAPINewSpotOrderRequest,
   WSAPIOpenOrdersCancelAllRequest,
   WSAPIOpenOrdersStatusRequest,
+  WSAPIOrderAmendKeepPriorityRequest,
   WSAPIOrderBookRequest,
   WSAPIOrderCancelReplaceRequest,
   WSAPIOrderCancelRequest,
@@ -253,15 +258,6 @@ export class WebsocketAPIClient {
     );
   }
 
-  getSpotSessionStatus(
-    wsKey?: WSAPIWsKeyMain,
-  ): Promise<WSAPIResponse<WSAPISessionStatus>> {
-    return this.wsClient.sendWSAPIRequest(
-      wsKey || WS_KEY_MAP.mainWSAPI,
-      'session.status',
-    );
-  }
-
   /*
    *
    * SPOT - Market data requests
@@ -458,6 +454,23 @@ export class WebsocketAPIClient {
     );
   }
 
+  /*
+   *
+   * SPOT - Session authentication requests
+   *
+   * Note: authentication is automatic
+   *
+   */
+
+  getSpotSessionStatus(
+    wsKey?: WSAPIWsKeyMain,
+  ): Promise<WSAPIResponse<WSAPISessionStatus>> {
+    return this.wsClient.sendWSAPIRequest(
+      wsKey || WS_KEY_MAP.mainWSAPI,
+      'session.status',
+    );
+  }
+
   /*
    *
    * SPOT - Trading requests
@@ -540,6 +553,22 @@ export class WebsocketAPIClient {
     );
   }
 
+  /**
+   * Reduce the quantity of an existing open order.
+   *
+   * Read for more info: https://developers.binance.com/docs/binance-spot-api-docs/faqs/order_amend_keep_priority
+   */
+  amendKeepPrioritySpotOrder(
+    params: WSAPIOrderAmendKeepPriorityRequest,
+    wsKey?: WSAPIWsKeyMain,
+  ): Promise<WSAPIResponse<SpotAmendKeepPriorityResult>> {
+    return this.wsClient.sendWSAPIRequest(
+      wsKey || WS_KEY_MAP.mainWSAPI,
+      'order.amend.keepPriority',
+      params,
+    );
+  }
+
   /**
    * Query execution status of all open orders
    * Note: If you need to continuously monitor order status updates, consider using WebSocket Streams