feat(v3.0.0-beta.16): add flag for public wsapi commands that do not require auth. add better message when keys are required but missing

Author: tiagosiebler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "binance",
-  "version": "3.0.0-beta.15",
+  "version": "3.0.0-beta.16",
   "description": "Professional Node.js & JavaScript SDK for Binance REST APIs & WebSockets, with TypeScript & end-to-end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package.json

@@ -226,6 +226,8 @@ export class WebsocketAPIClient {
     return this.wsClient.sendWSAPIRequest(
       wsKey || WS_KEY_MAP.mainWSAPI,
       'ping',
+      undefined,
+      { authIsOptional: true },
     );
   }
 
@@ -238,6 +240,8 @@ export class WebsocketAPIClient {
     return this.wsClient.sendWSAPIRequest(
       wsKey || WS_KEY_MAP.mainWSAPI,
       'time',
+      undefined,
+      { authIsOptional: true },
     );
   }
 
@@ -252,6 +256,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'exchangeInfo',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -273,6 +278,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'depth',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -288,6 +294,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'trades.recent',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -303,6 +310,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'trades.historical',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -318,6 +326,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'trades.aggregate',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -333,6 +342,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'klines',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -348,6 +358,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'uiKlines',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -362,6 +373,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'avgPrice',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -381,6 +393,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'ticker.24hr',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -399,6 +412,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'ticker.tradingDay',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -418,6 +432,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'ticker',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -433,6 +448,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'ticker.price',
       params,
+      { authIsOptional: true },
     );
   }
 
@@ -448,6 +464,7 @@ export class WebsocketAPIClient {
       wsKey || WS_KEY_MAP.mainWSAPI,
       'ticker.book',
       params,
+      { authIsOptional: true },
     );
   }
 

src/websocket-api-client.ts

@@ -63,6 +63,11 @@ import { WSConnectedResult } from './util/websockets/WsStore.types';
 
 const WS_LOGGER_CATEGORY = { category: 'binance-ws' };
 
+export interface WSAPIRequestFlags {
+  /** If true, will skip auth requirement for WS API connection */
+  authIsOptional?: boolean | undefined;
+}
+
 /**
  * Multiplex Node.js, JavaScript & TypeScript Websocket Client for all of Binance's available WebSockets.
  *
@@ -298,7 +303,8 @@ export class WebsocketClient extends BaseWebsocketClient<
   >(
     wsKey: TWSKey,
     operation: TWSOperation,
-    ...params: TWSParams extends void | never ? [] | [undefined] : [TWSParams]
+    params?: TWSParams extends void | never ? undefined : TWSParams,
+    requestFlags?: WSAPIRequestFlags,
   ): Promise<TWSAPIResponse>;
 
   async sendWSAPIRequest<
@@ -311,9 +317,12 @@ export class WebsocketClient extends BaseWebsocketClient<
     wsKey: WsKey,
     operation: TWSOperation,
     params: TWSParams & { signRequest?: boolean },
+    requestFlags?: WSAPIRequestFlags,
   ): Promise<TWSAPIResponse> {
     /**
-     * Spot: https://developers.binance.com/docs/binance-spot-api-docs/websocket-api/general-api-information
+     * Spot:
+     * -> https://developers.binance.com/docs/binance-spot-api-docs/websocket-api/general-api-information
+     * -> https://github.com/binance/binance-spot-api-docs/blob/master/web-socket-api.md#public-api-requests
      * USDM Futures: https://developers.binance.com/docs/derivatives/usds-margined-futures/websocket-api-general-info
      * COINM Futures: https://developers.binance.com/docs/derivatives/coin-margined-futures/websocket-api-general-info
      */
@@ -326,12 +335,14 @@ export class WebsocketClient extends BaseWebsocketClient<
     await this.assertIsConnected(resolvedWsKey);
     // this.logger.trace('sendWSAPIRequest(): assertIsConnected(${wsKey}) ok');
 
-    // this.logger.trace('sendWSAPIRequest(): assertIsAuthenticated(${wsKey})...');
-    await this.assertIsAuthenticated(resolvedWsKey);
+    // Some commands don't require authentication.
+    if (requestFlags?.authIsOptional !== true) {
+      // this.logger.trace('sendWSAPIRequest(): assertIsAuthenticated(${wsKey})...');
+      await this.assertIsAuthenticated(resolvedWsKey);
+      // this.logger.trace('sendWSAPIRequest(): assertIsAuthenticated(${wsKey}) ok');
+    }
     const timestampAfterAuth = Date.now();
 
-    // this.logger.trace('sendWSAPIRequest(): assertIsAuthenticated(${wsKey}) ok');
-
     const request: WsRequestOperationBinance<string> = {
       id: this.getNewRequestId(),
       method: operation,
@@ -371,6 +382,7 @@ export class WebsocketClient extends BaseWebsocketClient<
       TWSAPIResponse & { request: any }
     >(resolvedWsKey, promiseRef, false);
 
+    // Enrich returned promise with request context for easier debugging
     deferredPromise.promise
       ?.then((res) => {
         if (!Array.isArray(res)) {