Merge pull request #629 from tiagosiebler/optionsws

fix(v3.2.0): update options ws connectivity and example, audit dependency bump

Author: tiagosiebler

examples/WebSockets/ws-public.ts

@@ -279,29 +279,45 @@ import {
     );
 
     /**
-     * Subscribe to each available european options market data websocket topic, the new way:
-     *
-     * https://developers.binance.com/docs/derivatives/option/websocket-market-streams/New-Symbol-Info
+     * Subscribe to each available options market data websocket topic, the new way:
      *
+     * https://developers.binance.com/docs/derivatives/options-trading/websocket-market-streams/New-Symbol-Info
      * https://eapi.binance.com/eapi/v1/exchangeInfo
      */
-    const optionsAsset = 'ETH';
-    const optionsExpiration = '250328';
-    const optionsSymbol = 'BTC-250328-140000-C';
+
+    const optionsAsset = 'ethusdt';
+    const optionsExpiration = '260128'; // YYMMDD
+    const optionsSymbol = 'ETH-260128-3000-C';
+    const optionsSymbol2 = 'ETH-260129-2950-C';
+    const KlineInterval = '1m';
     await wsClient.subscribe(
       [
-        'option_pair',
+        '!optionSymbol',
         `${optionsAsset}@openInterest@${optionsExpiration}`,
-        `${optionsAsset}@markPrice`,
-        `${optionsSymbol}@kline_1m`,
-        `${optionsAsset}@ticker@${optionsExpiration}`,
-        `${symbol}@index`,
-        `${optionsAsset}@trade`,
-        `${optionsSymbol}@depth100`,
+        `${optionsAsset}@optionMarkPrice`,
+        `${optionsSymbol}@kline_${KlineInterval}`,
+        `${optionsSymbol2}@kline_${KlineInterval}`,
+        '!index@arr',
+        `${symbol}@bookTicker`,
+        `${symbol}@optionTicker`,
+        `${symbol}@optionTrade`,
+        `${symbol}@depth5@100ms`,
+        `${symbol}@depth@100ms`,
       ],
       'eoptions',
     );
 
+    // You can send raw commands, such as asking for list of active subscriptions after 5 seconds. Use with caution:
+    // setTimeout(() => {
+    //   wsClient.tryWsSend(
+    //     'eoptions',
+    //     JSON.stringify({
+    //       method: 'LIST_SUBSCRIPTIONS',
+    //       id: Date.now(),
+    //     }),
+    //   );
+    // }, 1000 * 5);
+
     // /**
     //  *
     //  * For those that used the Node.js Binance SDK before the v3 release, you can

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "binance",
-  "version": "3.1.9",
+  "version": "3.2.0",
   "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

@@ -167,9 +167,10 @@ export const WS_KEY_URL_MAP: Record<WsKey, string> = {
   coinmWSAPI: 'wss://ws-dapi.binance.com',
   coinmWSAPITestnet: 'coinmWSAPITestnet',
 
-  // https://developers.binance.com/docs/derivatives/option/websocket-market-streams
-  // https://developers.binance.com/docs/derivatives/option/user-data-streams
-  eoptions: 'wss://nbstream.binance.com/eoptions',
+  // https://developers.binance.com/docs/derivatives/options-trading/websocket-market-streams
+  // https://developers.binance.com/docs/derivatives/options-trading/user-data-streams
+  eoptions: 'wss://fstream.binance.com',
+  // eoptions: 'wss://nbstream.binance.com/eoptions',
   // optionsTestnet: 'wss://testnetws.binanceops.com',
 
   // https://developers.binance.com/docs/derivatives/portfolio-margin/user-data-streams
@@ -303,9 +304,9 @@ export function getWsURLSuffix(
     case 'eoptions':
       switch (connectionType) {
         case 'market':
-          return '/stream';
+          return '/market/stream';
         case 'userData':
-          return '/ws';
+          return '/private/ws';
         default: {
           throw neverGuard(
             connectionType,