feat(): refactor rest client cache out of ws client

Author: tiagosiebler

examples/rest-usdm-order-sl.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
 import { USDMClient } from '../src/index';
 
 // or
@@ -26,8 +27,8 @@ async function start() {
      */
     const [
       { positionAmt: longAmount, ...long },
-      { positionAmt: shortAmount, ...short }
-    ]: any = await client.getPositions({ symbol });
+      { positionAmt: shortAmount, ...short },
+    ]: any = await client.getPositionsV3({ symbol });
 
     // if longAmount is bigger than 0 means we have open long position and if shortAmount is below 0 means we have open short position
     const hasLong = parseFloat(longAmount) > 0;
@@ -36,16 +37,17 @@ async function start() {
 
     // if we have any open position then we continue
     if (hasOpen) {
-
       // we get ourstop loss here
       const orders = await client.getAllOpenOrders({ symbol });
-      const stopOrders = orders.filter(({ type }) => type === 'STOP_MARKET') ?? {};
+      const stopOrders =
+        orders.filter(({ type }) => type === 'STOP_MARKET') ?? [];
 
-      // we want to modify our long position SL here 
+      // we want to modify our long position SL here
       if (hasLong) {
-
         // we get the StopLoss order which is realted to long
-        const { orderId }: any = stopOrders.find(({ positionSide: ps }) => ps == 'LONG');
+        const { orderId }: any = stopOrders.find(
+          ({ positionSide: ps }) => ps == 'LONG',
+        );
 
         // if it exists, cancel it.
         if (orderId) {
@@ -62,8 +64,8 @@ async function start() {
           timeInForce: 'GTC',
           type: 'STOP_MARKET',
           closePosition: 'true', // this is here because we don't have the position quantity value, and it means closee all quantity
-          stopPrice: parseFloat((markPrice * .99).toFixed(3)), // set sl price 1% below current price
-          workingType: 'MARK_PRICE'
+          stopPrice: parseFloat((markPrice * 0.99).toFixed(3)), // set sl price 1% below current price
+          workingType: 'MARK_PRICE',
         });
         console.log('SL Modifiled sell result: ', result);
       }

examples/ws-userdata.ts

@@ -6,7 +6,7 @@ import {
   isWsFormattedUserDataEvent,
   WsUserDataEvents,
 } from '../src';
-import { WebsocketClientV1 } from '../src/websocket-client-legacy';
+import { WebsocketClientV1 } from '../src';
 
 // or
 // import { DefaultLogger, WebsocketClient } from 'binance';

src/util/websockets/rest-client-cache.ts

@@ -0,0 +1,80 @@
+import { AxiosRequestConfig } from 'axios';
+
+import { CoinMClient } from '../../coinm-client';
+import { MainClient } from '../../main-client';
+import { USDMClient } from '../../usdm-client';
+import { RestClientOptions } from '../requestUtils';
+
+interface RestClientStore {
+  spot: MainClient;
+  margin: MainClient;
+  usdmFutures: USDMClient;
+  usdmFuturesTestnet: USDMClient;
+  coinmFutures: CoinMClient;
+  coinmFuturesTestnet: CoinMClient;
+  // options: MainClient;
+}
+
+export class RestClientCache {
+  private restClients: Partial<RestClientStore>;
+
+  public getSpotRestClient(
+    restOptions: RestClientOptions,
+    requestOptions?: AxiosRequestConfig,
+  ): MainClient {
+    if (!this.restClients.spot) {
+      this.restClients.spot = new MainClient(restOptions, requestOptions);
+    }
+    return this.restClients.spot;
+  }
+
+  public getUSDMRestClient(
+    restOptions: RestClientOptions,
+    requestOptions?: AxiosRequestConfig,
+    isTestnet?: boolean,
+  ): USDMClient {
+    if (isTestnet) {
+      if (!this.restClients.usdmFuturesTestnet) {
+        this.restClients.usdmFuturesTestnet = new USDMClient(
+          restOptions,
+          requestOptions,
+          isTestnet, // TODO: migrate to using restOptions param instead, deprecate this flag
+        );
+      }
+      return this.restClients.usdmFuturesTestnet;
+    }
+
+    if (!this.restClients.usdmFutures) {
+      this.restClients.usdmFutures = new USDMClient(
+        restOptions,
+        requestOptions,
+      );
+    }
+    return this.restClients.usdmFutures;
+  }
+
+  public getCOINMRestClient(
+    restOptions: RestClientOptions,
+    requestOptions?: AxiosRequestConfig,
+    isTestnet?: boolean,
+  ): CoinMClient {
+    if (isTestnet) {
+      if (!this.restClients.coinmFuturesTestnet) {
+        this.restClients.coinmFuturesTestnet = new CoinMClient(
+          restOptions,
+          requestOptions,
+          isTestnet, // TODO: migrate to using restOptions param instead, deprecate this flag
+        );
+      }
+      return this.restClients.coinmFuturesTestnet;
+    }
+
+    if (!this.restClients.coinmFutures) {
+      this.restClients.coinmFutures = new CoinMClient(
+        restOptions,
+        requestOptions,
+      );
+    }
+    return this.restClients.coinmFutures;
+  }
+}

src/util/websockets/websocket-util.ts

@@ -145,7 +145,7 @@ export const WS_AUTH_ON_CONNECT_KEYS: WsKey[] = [
 // ] as WsKey[];
 
 /** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
-const PRIVATE_TOPICS = [];
+const PRIVATE_TOPICS: string[] = [];
 
 /**
  * Normalised internal format for a request (subscribe/unsubscribe/etc) on a topic, with optional parameters.