deprecate redundant repeated constructors

src/account-asset-client.ts

@@ -1,4 +1,3 @@
-import { AxiosRequestConfig } from 'axios';
 import {
   AccountAssetInformationRequest,
   APIResponseWithTime,
@@ -12,39 +11,15 @@ import {
   WithdrawalRecordsRequest,
   WithdrawalRequest,
 } from './types';
-import {
+import { REST_CLIENT_TYPE_ENUM } from './util';
-  RestClientOptions,
-  getRestBaseUrl,
-  REST_CLIENT_TYPE_ENUM,
-} from './util';
 import BaseRestClient from './util/BaseRestClient';
 
+/**
+ * REST API client for Account Asset APIs
+ */
 export class AccountAssetClient extends BaseRestClient {
-  /**
+  getClientType() {
-   * @public Creates an instance of the Account Asset REST API client.
+    return REST_CLIENT_TYPE_ENUM.accountAsset;
-   *
-   * @param {string} key - your API key
-   * @param {string} secret - your API secret
-   * @param {boolean} [useLivenet=false]
-   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
-   * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
-   */
-  constructor(
-    key?: string | undefined,
-    secret?: string | undefined,
-    useLivenet: boolean = false,
-    restClientOptions: RestClientOptions = {},
-    requestOptions: AxiosRequestConfig = {}
-  ) {
-    super(
-      key,
-      secret,
-      getRestBaseUrl(useLivenet, restClientOptions),
-      restClientOptions,
-      requestOptions,
-      REST_CLIENT_TYPE_ENUM.accountAsset
-    );
-    return this;
   }
 
   async fetchServerTime(): Promise<number> {

src/inverse-client.ts

@@ -1,9 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { REST_CLIENT_TYPE_ENUM } from './util';
-import {
-  getRestBaseUrl,
-  RestClientOptions,
-  REST_CLIENT_TYPE_ENUM,
-} from './util';
 import {
   APIResponseWithTime,
   AssetExchangeRecordsReq,
@@ -18,32 +13,12 @@ import {
 } from './types';
 import BaseRestClient from './util/BaseRestClient';
 
+/**
+ * REST API client for Inverse Perpetual Futures APIs (v2)
+ */
 export class InverseClient extends BaseRestClient {
-  /**
+  getClientType() {
-   * @public Creates an instance of the inverse REST API client.
+    return REST_CLIENT_TYPE_ENUM.inverse;
-   *
-   * @param {string} key - your API key
-   * @param {string} secret - your API secret
-   * @param {boolean} [useLivenet=false]
-   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
-   * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
-   */
-  constructor(
-    key?: string | undefined,
-    secret?: string | undefined,
-    useLivenet: boolean = false,
-    restClientOptions: RestClientOptions = {},
-    requestOptions: AxiosRequestConfig = {}
-  ) {
-    super(
-      key,
-      secret,
-      getRestBaseUrl(useLivenet, restClientOptions),
-      restClientOptions,
-      requestOptions,
-      REST_CLIENT_TYPE_ENUM.inverse
-    );
-    return this;
   }
 
   async fetchServerTime(): Promise<number> {

src/inverse-futures-client.ts

@@ -1,9 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { REST_CLIENT_TYPE_ENUM } from './util/requestUtils';
-import {
-  getRestBaseUrl,
-  RestClientOptions,
-  REST_CLIENT_TYPE_ENUM,
-} from './util/requestUtils';
 import {
   APIResponseWithTime,
   AssetExchangeRecordsReq,
@@ -18,32 +13,12 @@ import {
 } from './types/shared';
 import BaseRestClient from './util/BaseRestClient';
 
+/**
+ * REST API client for Inverse Futures APIs (e.g. quarterly futures) (v2)
+ */
 export class InverseFuturesClient extends BaseRestClient {
-  /**
+  getClientType() {
-   * @public Creates an instance of the inverse futures REST API client.
+    return REST_CLIENT_TYPE_ENUM.inverseFutures;
-   *
-   * @param {string} key - your API key
-   * @param {string} secret - your API secret
-   * @param {boolean} [useLivenet=false]
-   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
-   * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
-   */
-  constructor(
-    key?: string | undefined,
-    secret?: string | undefined,
-    useLivenet: boolean = false,
-    restClientOptions: RestClientOptions = {},
-    requestOptions: AxiosRequestConfig = {}
-  ) {
-    super(
-      key,
-      secret,
-      getRestBaseUrl(useLivenet, restClientOptions),
-      restClientOptions,
-      requestOptions,
-      REST_CLIENT_TYPE_ENUM.inverseFutures
-    );
-    return this;
   }
 
   async fetchServerTime(): Promise<number> {

src/linear-client.ts

@@ -1,9 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { REST_CLIENT_TYPE_ENUM } from './util/requestUtils';
-import {
-  getRestBaseUrl,
-  RestClientOptions,
-  REST_CLIENT_TYPE_ENUM,
-} from './util/requestUtils';
 import {
   APIResponse,
   APIResponseWithTime,
@@ -25,32 +20,12 @@ import {
 import { linearPositionModeEnum, positionTpSlModeEnum } from './constants/enum';
 import BaseRestClient from './util/BaseRestClient';
 
+/**
+ * REST API client for linear/USD perpetual futures APIs (v2)
+ */
 export class LinearClient extends BaseRestClient {
-  /**
+  getClientType() {
-   * @public Creates an instance of the linear (USD Perps) REST API client.
+    return REST_CLIENT_TYPE_ENUM.linear;
-   *
-   * @param {string} key - your API key
-   * @param {string} secret - your API secret
-   * @param {boolean} [useLivenet=false]
-   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
-   * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
-   */
-  constructor(
-    key?: string | undefined,
-    secret?: string | undefined,
-    useLivenet: boolean = false,
-    restClientOptions: RestClientOptions = {},
-    requestOptions: AxiosRequestConfig = {}
-  ) {
-    super(
-      key,
-      secret,
-      getRestBaseUrl(useLivenet, restClientOptions),
-      restClientOptions,
-      requestOptions,
-      REST_CLIENT_TYPE_ENUM.linear
-    );
-    return this;
   }
 
   async fetchServerTime(): Promise<number> {

src/spot-client.ts

@@ -1,4 +1,3 @@
-import { AxiosRequestConfig } from 'axios';
 import {
   NewSpotOrder,
   APIResponse,
@@ -11,40 +10,14 @@ import {
   SpotSymbolInfo,
 } from './types';
 import BaseRestClient from './util/BaseRestClient';
-import {
+import { agentSource, REST_CLIENT_TYPE_ENUM } from './util/requestUtils';
-  agentSource,
-  getRestBaseUrl,
-  RestClientOptions,
-  REST_CLIENT_TYPE_ENUM,
-} from './util/requestUtils';
 
+/**
+ * REST API client for Spot APIs (v1)
+ */
 export class SpotClient extends BaseRestClient {
-  /**
+  getClientType() {
-   * @public Creates an instance of the Spot REST API client.
+    return REST_CLIENT_TYPE_ENUM.spot;
-   *
-   * @param {string} key - your API key
-   * @param {string} secret - your API secret
-   * @param {boolean} [useLivenet=false]
-   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
-   * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
-   */
-  constructor(
-    key?: string | undefined,
-    secret?: string | undefined,
-    useLivenet: boolean = false,
-    restClientOptions: RestClientOptions = {},
-    requestOptions: AxiosRequestConfig = {}
-  ) {
-    super(
-      key,
-      secret,
-      getRestBaseUrl(useLivenet, restClientOptions),
-      restClientOptions,
-      requestOptions,
-      REST_CLIENT_TYPE_ENUM.spot
-    );
-
-    return this;
   }
 
   fetchServerTime(): Promise<number> {

src/usdc-options-client.ts

@@ -1,38 +1,13 @@
-import { AxiosRequestConfig } from 'axios';
 import { APIResponseWithTime } from './types';
-import {
+import { REST_CLIENT_TYPE_ENUM } from './util';
-  RestClientOptions,
-  getRestBaseUrl,
-  REST_CLIENT_TYPE_ENUM,
-} from './util';
 import BaseRestClient from './util/BaseRestClient';
 
+/**
+ * REST API client for USDC Options APIs
+ */
 export class USDCOptionsClient extends BaseRestClient {
-  /**
+  getClientType() {
-   * @public Creates an instance of the USDC Options REST API client.
+    return REST_CLIENT_TYPE_ENUM.usdcOptions;
-   *
-   * @param {string} key - your API key
-   * @param {string} secret - your API secret
-   * @param {boolean} [useLivenet=false] uses testnet by default
-   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
-   * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
-   */
-  constructor(
-    key?: string | undefined,
-    secret?: string | undefined,
-    useLivenet: boolean = false,
-    restClientOptions: RestClientOptions = {},
-    requestOptions: AxiosRequestConfig = {}
-  ) {
-    super(
-      key,
-      secret,
-      getRestBaseUrl(useLivenet, restClientOptions),
-      restClientOptions,
-      requestOptions,
-      REST_CLIENT_TYPE_ENUM.usdcOptions
-    );
-    return this;
   }
 
   async fetchServerTime(): Promise<number> {

src/util/BaseRestClient.ts

@@ -7,6 +7,7 @@ import {
   RestClientType,
   REST_CLIENT_TYPE_ENUM,
   agentSource,
+  getRestBaseUrl,
 } from './requestUtils';
 
 // axios.interceptors.request.use((request) => {
@@ -53,21 +54,32 @@ export default abstract class BaseRestClient {
   private secret: string | undefined;
   private clientType: RestClientType;
 
-  /** Function that calls exchange API to query & resolve server time, used by time sync */
+  /** Function that calls exchange API to query & resolve server time, used by time sync, disabled by default */
   abstract fetchServerTime(): Promise<number>;
 
+  /** Defines the client type (affecting how requests & signatures behave) */
+  abstract getClientType(): RestClientType;
+
+  /**
+   * Create an instance of the REST client
+   * @param {string} key - your API key
+   * @param {string} secret - your API secret
+   * @param {boolean} [useLivenet=false]
+   * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
+   * @param {AxiosRequestConfig} [requestOptions={}] HTTP networking options for axios
+   */
   constructor(
-    key: string | undefined,
+    key?: string | undefined,
-    secret: string | undefined,
+    secret?: string | undefined,
-    baseUrl: string,
+    useLivenet: boolean = false,
     options: RestClientOptions = {},
-    requestOptions: AxiosRequestConfig = {},
+    requestOptions: AxiosRequestConfig = {}
-    clientType: RestClientType
   ) {
+    const baseUrl = getRestBaseUrl(useLivenet, options);
     this.timeOffset = null;
     this.syncTimePromise = null;
 
-    this.clientType = clientType;
+    this.clientType = this.getClientType();
 
     this.options = {
       recv_window: 5000,
@@ -86,7 +98,7 @@ export default abstract class BaseRestClient {
       // custom request options based on axios specs - see: https://github.com/axios/axios#request-config
       ...requestOptions,
       headers: {
-        'x-referer': 'bybitapinode',
+        'x-referer': agentSource,
       },
     };