feat(v3.0.0-beta.13): add methods to unsubscribe user data streams (close connection), add example with demonstrations for each, fix(): insolated margin reconnection workflow, fix(): REST sign encoding with ed25519 keys

Author: tiagosiebler

examples/WebSockets/ws-userdata-listenkey.ts

@@ -18,6 +18,7 @@ import {
   WebsocketClient,
   WsUserDataEvents,
 } from '../../src/index';
+import { WsConnectionStateEnum } from '../../src/util/websockets/WsStore.types';
 
 (async () => {
   const key = process.env.API_KEY_COM || 'APIKEY';
@@ -154,13 +155,86 @@ import {
    *
    * Once subscribed, you don't need to do anything else. Listen-key keep-alive, refresh, reconnects, etc are all automatically handled by the SDK.
    */
+
+  // Example 1: Spot, by default, routes to the "main" wss domain "wss://stream.binance.com:9443".
+  // No parameters needed, just call the subscribe function.
   wsClient.subscribeSpotUserDataStream();
-  // wsClient.subscribeCrossMarginUserDataStream();
-  // wsClient.subscribeIsolatedMarginUserDataStream('BTCUSDT');
-  // wsClient.subscribeUsdFuturesUserDataStream();
-
-  // setTimeout(() => {
-  //   console.log('killing all connections');
-  //   wsClient.closeAll();
-  // }, 1000 * 15);
+
+  // // Example 2: Optional: subscribe to spot via other wss domains
+  wsClient.subscribeSpotUserDataStream('main2'); // routed to "wss://stream.binance.com:443"
+
+  // // Example 3: cross margin
+  wsClient.subscribeCrossMarginUserDataStream();
+
+  // Example 4: isolated margin
+  wsClient.subscribeIsolatedMarginUserDataStream('BTCUSDC');
+
+  /**
+   * Futures
+   */
+
+  // Example 5: usdm futures
+  wsClient.subscribeUsdFuturesUserDataStream();
+
+  // Example 6: coinm futures
+  wsClient.subscribeCoinFuturesUserDataStream();
+
+  // Example 7: portfolio margin
+  // wsClient.subscribePortfolioMarginUserDataStream();
+
+  // Example 8: portfolio margin pro
+  // wsClient.subscribePortfolioMarginUserDataStream('portfolioMarginProUserData');
+
+  // after 15 seconds, kill user data connections one by one (or all at once)
+  setTimeout(() => {
+    // console.log('killing all connections at once');
+    // wsClient.closeAll();
+
+    // or:
+    console.log('killing individual connections');
+
+    try {
+      // console.log('killing all connections');
+      // wsClient.closeAll();
+      // Example 1:
+      wsClient.unsubscribeSpotUserDataStream();
+      // Example 2: use the wsKey to route to another domain
+      wsClient.unsubscribeSpotUserDataStream('main2');
+      // Example 3: cross margin
+      wsClient.unsubscribeCrossMarginUserDataStream();
+      // Example 4: isolated margin
+      wsClient.unsubscribeIsolatedMarginUserDataStream('BTCUSDC');
+      // Example 5: usdm futures
+      wsClient.unsubscribeUsdFuturesUserDataStream();
+      // Example 6: coinm futures
+      wsClient.unsubscribeCoinFuturesUserDataStream();
+      // // Example 7: portfolio margin
+      // wsClient.unsubscribePortfolioMarginUserDataStream();
+      // // Example 8: portfolio margin pro
+      // wsClient.unsubscribePortfolioMarginUserDataStream(
+      //   'portfolioMarginProUserData',
+      // );
+    } catch (e) {
+      console.error('Exception trying to close a user data stream: ', e);
+    }
+  }, 1000 * 15);
+
+  // after 20 seconds, list the remaining open connections
+  setTimeout(() => {
+    try {
+      console.log(
+        'remaining connections:',
+        wsClient
+          .getWsStore()
+          .getKeys()
+          .filter(
+            (key) =>
+              wsClient.getWsStore().get(key)?.connectionState ===
+              WsConnectionStateEnum.CONNECTED,
+          ),
+      );
+    } catch (e) {
+      console.error('Exception trying to close a user data stream: ', e);
+    }
+  }, 1000 * 20);
 })();

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "binance",
-  "version": "3.0.0-beta.12",
+  "version": "3.0.0-beta.13",
   "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

@@ -20,11 +20,13 @@ export async function signMessage(
     }
 
     // fallback to ed25519
+    // ed25519 requires b64 encoding
+    const ed25519Method: SignEncodeMethod = 'base64';
     return sign(null, Buffer.from(message), {
       key: secret,
       padding: constants.RSA_PKCS1_PSS_PADDING,
       saltLength: constants.RSA_PSS_SALTLEN_DIGEST,
-    }).toString(pemEncodeMethod);
+    }).toString(ed25519Method);
   }
 
   // fallback to hmac

src/util/node-support.ts

@@ -118,7 +118,7 @@ export class UserDataStreamManager {
     miscState?: MiscUserDataConnectionState,
   ): Promise<WSConnectedResult | undefined> {
     const streamName = 'userData';
-    const symbol = undefined;
+    const symbol = miscState?.symbol;
 
     this.logger.trace('subscribeGeneralUserDataStreamWithListenKey(): ', {
       wsKey,

src/util/websockets/user-data-stream-manager.ts

@@ -645,6 +645,7 @@ export function parseRawWsMessage(event: any): any {
 export interface MiscUserDataConnectionState {
   isReconnecting?: boolean;
   respawnAttempt?: number;
+  symbol?: string; // isolated margin is per symbol
 }
 
 interface WsContext {