Merge pull request #139 from tiagosiebler/businesstopicoptauth

fix(v3.0.5, #137): handling for mixed-auth connections should only auth once private topic is requested

Author: tiagosiebler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "description": "Complete Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
   "scripts": {
     "test": "jest",

package.json

@@ -16,6 +16,7 @@ import { DefaultLogger } from './logger.js';
 import { checkWebCryptoAPISupported } from './webCryptoAPI.js';
 import {
   getNormalisedTopicRequests,
+  PRIVATE_CHANNELS,
   safeTerminateWs,
   WS_LOGGER_CATEGORY,
   WsTopicRequest,
@@ -330,8 +331,22 @@ export abstract class BaseWebsocketClient<
 
     // We're connected. Check if auth is needed and if already authenticated
     const isPrivateConnection = this.isPrivateWsKey(wsKey);
-    const isAuthenticated = this.wsStore.get(wsKey)?.isAuthenticated;
-    if (isPrivateConnection && !isAuthenticated) {
+    const isAuthenticatedBeforeTopicCheck =
+      this.wsStore.get(wsKey)?.isAuthenticated;
+
+    if (!isAuthenticatedBeforeTopicCheck && !isPrivateConnection) {
+      // Connection hasn't been authenticated yet, do a quick check if any topics we're about to subscribe to require auth
+      // Queue immediate auth if so
+      for (const topicRequest of normalisedTopicRequests) {
+        if (PRIVATE_CHANNELS.includes(topicRequest.topic)) {
+          await this.assertIsAuthenticated(wsKey);
+          break;
+        }
+      }
+    }
+
+    const isFinallyAuthenticated = this.wsStore.get(wsKey)?.isAuthenticated;
+    if (isPrivateConnection && !isFinallyAuthenticated) {
       /**
        * If not authenticated yet and auth is required, don't request topics yet.
        *

src/util/BaseWSClient.ts

@@ -148,16 +148,20 @@ export type WsKey = (typeof WS_KEY_MAP)[keyof typeof WS_KEY_MAP];
 
 export const PRIVATE_WS_KEYS: WsKey[] = [
   WS_KEY_MAP.prodPrivate,
-  WS_KEY_MAP.prodBusiness,
   WS_KEY_MAP.prodDemoPrivate,
-  WS_KEY_MAP.prodDemoBusiness,
   WS_KEY_MAP.eeaLivePrivate,
-  WS_KEY_MAP.eeaLiveBusiness,
   WS_KEY_MAP.eeaDemoPrivate,
-  WS_KEY_MAP.eeaDemoBusiness,
   WS_KEY_MAP.usLivePrivate,
-  WS_KEY_MAP.usLiveBusiness,
   WS_KEY_MAP.usDemoPrivate,
+];
+
+// These sometimes need auth, depending on the topic
+export const MIXED_WS_KEYS: WsKey[] = [
+  WS_KEY_MAP.prodBusiness,
+  WS_KEY_MAP.prodDemoBusiness,
+  WS_KEY_MAP.eeaLiveBusiness,
+  WS_KEY_MAP.eeaDemoBusiness,
+  WS_KEY_MAP.usLiveBusiness,
   WS_KEY_MAP.usDemoBusiness,
 ];
 
@@ -214,7 +218,7 @@ export function getDemoWsKey(wsKey: WsKey): WsKey {
 }
 
 /** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
-const PRIVATE_CHANNELS = [
+export const PRIVATE_CHANNELS = [
   'account',
   'positions',
   'balance_and_position',