bitget-api 0.0.1 → 1.0.0

package/lib/util/browser-support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-support.js","sourceRoot":"","sources":["../../src/util/browser-support.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,SAAS,oBAAoB,CAAC,MAAmB;IAC/C,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;QAC5B,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KACzC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED,SAAsB,WAAW,CAC/B,OAAe,EACf,MAAc,EACd,MAAwB;;QAExB,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAC9C,KAAK,EACL,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EACtB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAC3C,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAC/C,MAAM,EACN,GAAG,EACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CACxB,CAAC;QAEF,QAAQ,MAAM,EAAE;YACd,KAAK,KAAK,CAAC,CAAC;gBACV,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG;qBACvB,IAAI,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAM,EAAE,EAAE,CAC1C,CAAC,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAClC;qBACA,IAAI,CAAC,EAAE,CAAC,CAAC;aACb;YACD,KAAK,QAAQ,CAAC,CAAC;gBACb,OAAO,oBAAoB,CAAC,SAAS,CAAC,CAAC;aACxC;YACD,OAAO,CAAC,CAAC;gBACP,CAAC,CAAC,CAAQ,EAAE,EAAE,GAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;aACrD;SACF;IACH,CAAC;CAAA;AApCD,kCAoCC"}

package/lib/util/index.d.ts

@@ -0,0 +1,6 @@
+export * from './BaseRestClient';
+export * from './requestUtils';
+export * from './WsStore';
+export * from './logger';
+export * from './type-guards';
+export * from './websocket-util';

package/lib/util/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BaseRestClient"), exports);
+__exportStar(require("./requestUtils"), exports);
+__exportStar(require("./WsStore"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./type-guards"), exports);
+__exportStar(require("./websocket-util"), exports);
+//# sourceMappingURL=index.js.map

package/lib/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,iDAA+B;AAC/B,4CAA0B;AAC1B,2CAAyB;AACzB,gDAA8B;AAC9B,mDAAiC"}

package/lib/util/logger.d.ts

@@ -0,0 +1,9 @@
+export declare type LogParams = null | any;
+export declare const DefaultLogger: {
+    silly: (...params: LogParams) => void;
+    debug: (...params: LogParams) => void;
+    notice: (...params: LogParams) => void;
+    info: (...params: LogParams) => void;
+    warning: (...params: LogParams) => void;
+    error: (...params: LogParams) => void;
+};

package/lib/util/logger.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultLogger = void 0;
+exports.DefaultLogger = {
+    silly: (...params) => {
+        // console.log(params);
+    },
+    debug: (...params) => {
+        console.log(params);
+    },
+    notice: (...params) => {
+        console.log(params);
+    },
+    info: (...params) => {
+        console.info(params);
+    },
+    warning: (...params) => {
+        console.error(params);
+    },
+    error: (...params) => {
+        console.error(params);
+    },
+};
+//# sourceMappingURL=logger.js.map

package/lib/util/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG;IAC3B,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,uBAAuB;IACzB,CAAC;IACD,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IACD,MAAM,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACrC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IACD,IAAI,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACnC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACtC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IACD,KAAK,EAAE,CAAC,GAAG,MAAiB,EAAQ,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;CACF,CAAC"}

package/lib/util/node-support.d.ts

@@ -0,0 +1,2 @@
+/** This is async because the browser version uses a promise (browser-support) */
+export declare function signMessage(message: string, secret: string, method: 'hex' | 'base64'): Promise<string>;

package/lib/util/node-support.js

@@ -0,0 +1,33 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signMessage = void 0;
+const crypto_1 = require("crypto");
+/** This is async because the browser version uses a promise (browser-support) */
+function signMessage(message, secret, method) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const hmac = (0, crypto_1.createHmac)('sha256', secret).update(message);
+        switch (method) {
+            case 'hex': {
+                return hmac.digest('hex');
+            }
+            case 'base64': {
+                return hmac.digest().toString('base64');
+            }
+            default: {
+                ((x) => { })(method);
+                throw new Error(`Unhandled sign method: ${method}`);
+            }
+        }
+    });
+}
+exports.signMessage = signMessage;
+//# sourceMappingURL=node-support.js.map

package/lib/util/node-support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-support.js","sourceRoot":"","sources":["../../src/util/node-support.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAoC;AAEpC,iFAAiF;AACjF,SAAsB,WAAW,CAC/B,OAAe,EACf,MAAc,EACd,MAAwB;;QAExB,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1D,QAAQ,MAAM,EAAE;YACd,KAAK,KAAK,CAAC,CAAC;gBACV,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC3B;YACD,KAAK,QAAQ,CAAC,CAAC;gBACb,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aACzC;YACD,OAAO,CAAC,CAAC;gBACP,CAAC,CAAC,CAAQ,EAAE,EAAE,GAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;aACrD;SACF;IACH,CAAC;CAAA;AAnBD,kCAmBC"}

package/lib/util/requestUtils.d.ts

@@ -0,0 +1,31 @@
+export interface RestClientOptions {
+    /** Your API key */
+    apiKey?: string;
+    /** Your API secret */
+    apiSecret?: string;
+    /** The passphrase you set when creating the API Key (NOT your account password) */
+    apiPass?: string;
+    /** Set to `true` to connect to testnet. Uses the live environment by default. */
+    /** Override the max size of the request window (in ms) */
+    recvWindow?: number;
+    /** Default: false. If true, we'll throw errors if any params are undefined */
+    strictParamValidation?: boolean;
+    /**
+     * Optionally override API protocol + domain
+     * e.g baseUrl: 'https://api.bitget.com'
+     **/
+    baseUrl?: string;
+    /** Default: true. whether to try and post-process request exceptions (and throw them). */
+    parseExceptions?: boolean;
+}
+export declare function serializeParams<T extends object | undefined = {}>(params: T, strict_validation?: boolean, prefixWith?: string): string;
+export declare function getRestBaseUrl(useTestnet: boolean, restInverseOptions: RestClientOptions): string;
+export declare function isWsPong(msg: any): boolean;
+/**
+ * Used to switch how authentication/requests work under the hood (primarily for SPOT since it's different there)
+ */
+export declare const REST_CLIENT_TYPE_ENUM: {
+    readonly spot: "spot";
+    readonly futures: "futures";
+    readonly broker: "broker";
+};

package/lib/util/requestUtils.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REST_CLIENT_TYPE_ENUM = exports.isWsPong = exports.getRestBaseUrl = exports.serializeParams = void 0;
+function serializeParams(params, strict_validation = false, prefixWith = '') {
+    if (!params) {
+        return '';
+    }
+    const queryString = Object.keys(params)
+        .sort()
+        .map((key) => {
+        const value = params[key];
+        if (strict_validation === true && typeof value === 'undefined') {
+            throw new Error('Failed to sign API request due to undefined parameter');
+        }
+        return `${key}=${value}`;
+    })
+        .join('&');
+    // Only prefix if there's a value
+    return queryString ? prefixWith + queryString : queryString;
+}
+exports.serializeParams = serializeParams;
+function getRestBaseUrl(useTestnet, restInverseOptions) {
+    const exchangeBaseUrls = {
+        livenet: 'https://api.bitget.com',
+        livenet2: 'https://capi.bitget.com',
+        testnet: 'https://noTestnet',
+    };
+    if (restInverseOptions.baseUrl) {
+        return restInverseOptions.baseUrl;
+    }
+    if (useTestnet) {
+        return exchangeBaseUrls.testnet;
+    }
+    return exchangeBaseUrls.livenet;
+}
+exports.getRestBaseUrl = getRestBaseUrl;
+function isWsPong(msg) {
+    // bitget
+    if ((msg === null || msg === void 0 ? void 0 : msg.data) === 'pong') {
+        return true;
+    }
+    return false;
+}
+exports.isWsPong = isWsPong;
+/**
+ * Used to switch how authentication/requests work under the hood (primarily for SPOT since it's different there)
+ */
+exports.REST_CLIENT_TYPE_ENUM = {
+    spot: 'spot',
+    futures: 'futures',
+    broker: 'broker',
+};
+//# sourceMappingURL=requestUtils.js.map

package/lib/util/requestUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;AA6BA,SAAgB,eAAe,CAC7B,MAAS,EACT,iBAAiB,GAAG,KAAK,EACzB,aAAqB,EAAE;IAEvB,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC;KACX;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;SACH;QACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iCAAiC;IACjC,OAAO,WAAW,CAAC,CAAC,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AAC9D,CAAC;AAxBD,0CAwBC;AAED,SAAgB,cAAc,CAC5B,UAAmB,EACnB,kBAAqC;IAErC,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,wBAAwB;QACjC,QAAQ,EAAE,yBAAyB;QACnC,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE;QAC9B,OAAO,kBAAkB,CAAC,OAAO,CAAC;KACnC;IAED,IAAI,UAAU,EAAE;QACd,OAAO,gBAAgB,CAAC,OAAO,CAAC;KACjC;IAED,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC;AAnBD,wCAmBC;AAED,SAAgB,QAAQ,CAAC,GAAQ;IAC/B,SAAS;IACT,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,MAAM,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAND,4BAMC;AAED;;GAEG;AACU,QAAA,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACR,CAAC"}

package/lib/util/type-guards.d.ts

@@ -0,0 +1,9 @@
+import { WsAccountSnapshotUMCBL, WSPositionSnapshotUMCBL, WsSnapshotAccountEvent, WsSnapshotPositionsEvent } from '../types';
+/** TypeGuard: event is an account update (balance) */
+export declare function isWsAccountSnapshotEvent(event: unknown): event is WsSnapshotAccountEvent;
+/** TypeGuard: event is a positions update */
+export declare function isWsPositionsSnapshotEvent(event: unknown): event is WsSnapshotPositionsEvent;
+/** TypeGuard: event is a UMCBL account update (balance) */
+export declare function isWsFuturesAccountSnapshotEvent(event: unknown): event is WsAccountSnapshotUMCBL;
+/** TypeGuard: event is a UMCBL positions update */
+export declare function isWsFuturesPositionsSnapshotEvent(event: unknown): event is WSPositionSnapshotUMCBL;

package/lib/util/type-guards.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWsFuturesPositionsSnapshotEvent = exports.isWsFuturesAccountSnapshotEvent = exports.isWsPositionsSnapshotEvent = exports.isWsAccountSnapshotEvent = void 0;
+/** TypeGuard: event has a string "action" property */
+function isWsEvent(event) {
+    return (typeof event === 'object' &&
+        event &&
+        typeof event['action'] === 'string' &&
+        event['data']);
+}
+/** TypeGuard: event has "action === snapshot" */
+function isWsSnapshotEvent(event) {
+    return isWsEvent(event) && event.action === 'snapshot';
+}
+/** TypeGuard: event has a string channel name */
+function isWsChannelEvent(event) {
+    if (typeof event['arg'] === 'object' &&
+        event.arg &&
+        typeof (event === null || event === void 0 ? void 0 : event.arg['channel']) === 'string') {
+        return true;
+    }
+    return false;
+}
+/** TypeGuard: event is an account update (balance) */
+function isWsAccountSnapshotEvent(event) {
+    return (isWsSnapshotEvent(event) &&
+        isWsChannelEvent(event) &&
+        event.arg.channel === 'account' &&
+        Array.isArray(event.data));
+}
+exports.isWsAccountSnapshotEvent = isWsAccountSnapshotEvent;
+/** TypeGuard: event is a positions update */
+function isWsPositionsSnapshotEvent(event) {
+    return (isWsSnapshotEvent(event) &&
+        isWsChannelEvent(event) &&
+        event.arg.channel === 'positions' &&
+        Array.isArray(event.data));
+}
+exports.isWsPositionsSnapshotEvent = isWsPositionsSnapshotEvent;
+/** TypeGuard: event is a UMCBL account update (balance) */
+function isWsFuturesAccountSnapshotEvent(event) {
+    return isWsAccountSnapshotEvent(event) && event.arg.instType === 'umcbl';
+}
+exports.isWsFuturesAccountSnapshotEvent = isWsFuturesAccountSnapshotEvent;
+/** TypeGuard: event is a UMCBL positions update */
+function isWsFuturesPositionsSnapshotEvent(event) {
+    return isWsPositionsSnapshotEvent(event) && event.arg.instType === 'umcbl';
+}
+exports.isWsFuturesPositionsSnapshotEvent = isWsFuturesPositionsSnapshotEvent;
+//# sourceMappingURL=type-guards.js.map

package/lib/util/type-guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.js","sourceRoot":"","sources":["../../src/util/type-guards.ts"],"names":[],"mappings":";;;AASA,sDAAsD;AACtD,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK;QACL,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ;QACnC,KAAK,CAAC,MAAM,CAAC,CACd,CAAC;AACJ,CAAC;AAED,iDAAiD;AACjD,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,CAAC;AACzD,CAAC;AAED,iDAAiD;AACjD,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,IACE,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ;QAChC,KAAK,CAAC,GAAG;QACT,OAAO,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,CAAC,SAAS,CAAC,CAAA,KAAK,QAAQ,EACzC;QACA,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,sDAAsD;AACtD,SAAgB,wBAAwB,CACtC,KAAc;IAEd,OAAO,CACL,iBAAiB,CAAC,KAAK,CAAC;QACxB,gBAAgB,CAAC,KAAK,CAAC;QACvB,KAAK,CAAC,GAAG,CAAC,OAAO,KAAK,SAAS;QAC/B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAC1B,CAAC;AACJ,CAAC;AATD,4DASC;AAED,6CAA6C;AAC7C,SAAgB,0BAA0B,CACxC,KAAc;IAEd,OAAO,CACL,iBAAiB,CAAC,KAAK,CAAC;QACxB,gBAAgB,CAAC,KAAK,CAAC;QACvB,KAAK,CAAC,GAAG,CAAC,OAAO,KAAK,WAAW;QACjC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAC1B,CAAC;AACJ,CAAC;AATD,gEASC;AAED,2DAA2D;AAC3D,SAAgB,+BAA+B,CAC7C,KAAc;IAEd,OAAO,wBAAwB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC;AAC3E,CAAC;AAJD,0EAIC;AAED,mDAAmD;AACnD,SAAgB,iCAAiC,CAC/C,KAAc;IAEd,OAAO,0BAA0B,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC;AAC7E,CAAC;AAJD,8EAIC"}

package/lib/util/websocket-util.d.ts

@@ -0,0 +1,38 @@
+import { WsKey } from '../types';
+import { WsTopicSubscribeEventArgs } from './WsStore';
+/**
+ * Some exchanges have two livenet environments, some have test environments, some dont. This allows easy flexibility for different exchanges.
+ * Examples:
+ *  - One livenet and one testnet: NetworkMap<'livenet' | 'testnet'>
+ *  - One livenet, sometimes two, one testnet: NetworkMap<'livenet' | 'testnet', 'livenet2'>
+ *  - Only one livenet, no other networks: NetworkMap<'livenet'>
+ */
+declare type NetworkMap<TRequiredKeys extends string, TOptionalKeys extends string | undefined = undefined> = Record<TRequiredKeys, string> & (TOptionalKeys extends string ? Record<TOptionalKeys, string | undefined> : Record<TRequiredKeys, string>);
+export declare const WS_BASE_URL_MAP: Record<WsKey, Record<'all', NetworkMap<'livenet'>>>;
+/** Should be one WS key per unique URL */
+export declare const WS_KEY_MAP: {
+    readonly spotv1: "spotv1";
+    readonly mixv1: "mixv1";
+};
+/** Any WS keys in this list will trigger auth on connect, if credentials are available */
+export declare const WS_AUTH_ON_CONNECT_KEYS: WsKey[];
+/** Any WS keys in this list will ALWAYS skip the authentication process, even if credentials are available */
+export declare const PUBLIC_WS_KEYS: WsKey[];
+/**
+ * Used to automatically determine if a sub request should be to a public or private ws (when there's two separate connections).
+ * Unnecessary if there's only one connection to handle both public & private topics.
+ */
+export declare const PRIVATE_TOPICS: string[];
+export declare function isPrivateChannel<TChannel extends string>(channel: TChannel): boolean;
+export declare function getWsKeyForTopic(subscribeEvent: WsTopicSubscribeEventArgs, isPrivate?: boolean): WsKey;
+/** Force subscription requests to be sent in smaller batches, if a number is returned */
+export declare function getMaxTopicsPerSubscribeEvent(wsKey: WsKey): number | null;
+export declare const WS_ERROR_ENUM: {
+    INVALID_ACCESS_KEY: number;
+};
+export declare function neverGuard(x: never, msg: string): Error;
+export declare function getWsAuthSignature(apiKey: string | undefined, apiSecret: string | undefined, apiPass: string | undefined, recvWindow?: number): Promise<{
+    expiresAt: number;
+    signature: string;
+}>;
+export {};

package/lib/util/websocket-util.js

@@ -0,0 +1,100 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWsAuthSignature = exports.neverGuard = exports.WS_ERROR_ENUM = exports.getMaxTopicsPerSubscribeEvent = exports.getWsKeyForTopic = exports.isPrivateChannel = exports.PRIVATE_TOPICS = exports.PUBLIC_WS_KEYS = exports.WS_AUTH_ON_CONNECT_KEYS = exports.WS_KEY_MAP = exports.WS_BASE_URL_MAP = void 0;
+const node_support_1 = require("./node-support");
+exports.WS_BASE_URL_MAP = {
+    mixv1: {
+        all: {
+            livenet: 'wss://ws.bitget.com/mix/v1/stream',
+        },
+    },
+    spotv1: {
+        all: {
+            livenet: 'wss://ws.bitget.com/spot/v1/stream',
+        },
+    },
+};
+/** Should be one WS key per unique URL */
+exports.WS_KEY_MAP = {
+    spotv1: 'spotv1',
+    mixv1: 'mixv1',
+};
+/** Any WS keys in this list will trigger auth on connect, if credentials are available */
+exports.WS_AUTH_ON_CONNECT_KEYS = [
+    exports.WS_KEY_MAP.spotv1,
+    exports.WS_KEY_MAP.mixv1,
+];
+/** Any WS keys in this list will ALWAYS skip the authentication process, even if credentials are available */
+exports.PUBLIC_WS_KEYS = [];
+/**
+ * Used to automatically determine if a sub request should be to a public or private ws (when there's two separate connections).
+ * Unnecessary if there's only one connection to handle both public & private topics.
+ */
+exports.PRIVATE_TOPICS = ['account', 'orders', 'positions', 'ordersAlgo'];
+function isPrivateChannel(channel) {
+    return exports.PRIVATE_TOPICS.includes(channel);
+}
+exports.isPrivateChannel = isPrivateChannel;
+function getWsKeyForTopic(subscribeEvent, isPrivate) {
+    const instType = subscribeEvent.instType.toUpperCase();
+    switch (instType) {
+        case 'SP':
+        case 'SPBL': {
+            return exports.WS_KEY_MAP.spotv1;
+        }
+        case 'MC':
+        case 'UMCBL':
+        case 'DMCBL': {
+            return exports.WS_KEY_MAP.mixv1;
+        }
+        default: {
+            throw neverGuard(instType, `getWsKeyForTopic(): Unhandled market ${'instrumentId'}`);
+        }
+    }
+}
+exports.getWsKeyForTopic = getWsKeyForTopic;
+/** Force subscription requests to be sent in smaller batches, if a number is returned */
+function getMaxTopicsPerSubscribeEvent(wsKey) {
+    switch (wsKey) {
+        case 'mixv1':
+        case 'spotv1': {
+            // Technically there doesn't seem to be a documented cap, but there is a size limit per request. Doesn't hurt to batch requests.
+            return 15;
+        }
+        default: {
+            throw neverGuard(wsKey, `getWsKeyForTopic(): Unhandled wsKey`);
+        }
+    }
+}
+exports.getMaxTopicsPerSubscribeEvent = getMaxTopicsPerSubscribeEvent;
+exports.WS_ERROR_ENUM = {
+    INVALID_ACCESS_KEY: 30011,
+};
+function neverGuard(x, msg) {
+    return new Error(`Unhandled value exception "${x}", ${msg}`);
+}
+exports.neverGuard = neverGuard;
+function getWsAuthSignature(apiKey, apiSecret, apiPass, recvWindow = 0) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!apiKey || !apiSecret || !apiPass) {
+            throw new Error(`Cannot auth - missing api key, secret or passcode in config`);
+        }
+        const signatureExpiresAt = ((Date.now() + recvWindow) / 1000).toFixed(0);
+        const signature = yield (0, node_support_1.signMessage)(signatureExpiresAt + 'GET' + '/user/verify', apiSecret, 'base64');
+        return {
+            expiresAt: Number(signatureExpiresAt),
+            signature,
+        };
+    });
+}
+exports.getWsAuthSignature = getWsAuthSignature;
+//# sourceMappingURL=websocket-util.js.map

package/lib/util/websocket-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../src/util/websocket-util.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,iDAA6C;AAkBhC,QAAA,eAAe,GAGxB;IACF,KAAK,EAAE;QACL,GAAG,EAAE;YACH,OAAO,EAAE,mCAAmC;SAC7C;KACF;IACD,MAAM,EAAE;QACN,GAAG,EAAE;YACH,OAAO,EAAE,oCAAoC;SAC9C;KACF;CACF,CAAC;AAEF,0CAA0C;AAC7B,QAAA,UAAU,GAAG;IACxB,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;CACN,CAAC;AAEX,0FAA0F;AAC7E,QAAA,uBAAuB,GAAY;IAC9C,kBAAU,CAAC,MAAM;IACjB,kBAAU,CAAC,KAAK;CACjB,CAAC;AAEF,8GAA8G;AACjG,QAAA,cAAc,GAAG,EAAa,CAAC;AAE5C;;;GAGG;AACU,QAAA,cAAc,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;AAE/E,SAAgB,gBAAgB,CAC9B,OAAiB;IAEjB,OAAO,sBAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC1C,CAAC;AAJD,4CAIC;AAED,SAAgB,gBAAgB,CAC9B,cAAyC,EACzC,SAAmB;IAEnB,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC,WAAW,EAAoB,CAAC;IACzE,QAAQ,QAAQ,EAAE;QAChB,KAAK,IAAI,CAAC;QACV,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,kBAAU,CAAC,MAAM,CAAC;SAC1B;QACD,KAAK,IAAI,CAAC;QACV,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC,CAAC;YACZ,OAAO,kBAAU,CAAC,KAAK,CAAC;SACzB;QACD,OAAO,CAAC,CAAC;YACP,MAAM,UAAU,CACd,QAAQ,EACR,wCAAwC,cAAc,EAAE,CACzD,CAAC;SACH;KACF;AACH,CAAC;AAtBD,4CAsBC;AAED,yFAAyF;AACzF,SAAgB,6BAA6B,CAAC,KAAY;IACxD,QAAQ,KAAK,EAAE;QACb,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC,CAAC;YACb,gIAAgI;YAChI,OAAO,EAAE,CAAC;SACX;QACD,OAAO,CAAC,CAAC;YACP,MAAM,UAAU,CAAC,KAAK,EAAE,qCAAqC,CAAC,CAAC;SAChE;KACF;AACH,CAAC;AAXD,sEAWC;AAEY,QAAA,aAAa,GAAG;IAC3B,kBAAkB,EAAE,KAAK;CAC1B,CAAC;AAEF,SAAgB,UAAU,CAAC,CAAQ,EAAE,GAAW;IAC9C,OAAO,IAAI,KAAK,CAAC,8BAA8B,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAC/D,CAAC;AAFD,gCAEC;AAED,SAAsB,kBAAkB,CACtC,MAA0B,EAC1B,SAA6B,EAC7B,OAA2B,EAC3B,aAAqB,CAAC;;QAKtB,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE;YACrC,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;SACH;QACD,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEzE,MAAM,SAAS,GAAG,MAAM,IAAA,0BAAW,EACjC,kBAAkB,GAAG,KAAK,GAAG,cAAc,EAC3C,SAAS,EACT,QAAQ,CACT,CAAC;QAEF,OAAO;YACL,SAAS,EAAE,MAAM,CAAC,kBAAkB,CAAC;YACrC,SAAS;SACV,CAAC;IACJ,CAAC;CAAA;AA1BD,gDA0BC"}

package/lib/websocket-client.d.ts

@@ -0,0 +1,121 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import WebSocket from 'isomorphic-ws';
+import { BitgetInstType, WsTopicSubscribeEventArgs } from './util/WsStore';
+import { WSClientConfigurableOptions, WsKey, WsTopic } from './types';
+import { DefaultLogger } from './util';
+export declare type WsClientEvent = 'open' | 'update' | 'close' | 'exception' | 'reconnect' | 'reconnected' | 'response';
+interface WebsocketClientEvents {
+    /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+    open: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Reconnecting a dropped connection */
+    reconnect: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Successfully reconnected a connection that dropped */
+    reconnected: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Connection closed */
+    close: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Received reply to websocket command (e.g. after subscribing to topics) */
+    response: (response: any & {
+        wsKey: WsKey;
+    }) => void;
+    /** Received data for topic */
+    update: (response: any & {
+        wsKey: WsKey;
+    }) => void;
+    /** Exception from ws client OR custom listeners (e.g. if you throw inside your event handler) */
+    exception: (response: any & {
+        wsKey: WsKey;
+    }) => void;
+    /** Confirmation that a connection successfully authenticated */
+    authenticated: (event: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+}
+export declare interface WebsocketClient {
+    on<U extends keyof WebsocketClientEvents>(event: U, listener: WebsocketClientEvents[U]): this;
+    emit<U extends keyof WebsocketClientEvents>(event: U, ...args: Parameters<WebsocketClientEvents[U]>): boolean;
+}
+export declare class WebsocketClient extends EventEmitter {
+    private logger;
+    private options;
+    private wsStore;
+    constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
+    /**
+     * Subscribe to topics & track/persist them. They will be automatically resubscribed to if the connection drops/reconnects.
+     * @param wsTopics topic or list of topics
+     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
+     */
+    subscribe(wsTopics: WsTopicSubscribeEventArgs[] | WsTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
+    /**
+     * Unsubscribe from topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.
+     * @param wsTopics topic or list of topics
+     * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
+     */
+    unsubscribe(wsTopics: WsTopicSubscribeEventArgs[] | WsTopicSubscribeEventArgs, isPrivateTopic?: boolean): void;
+    /** Get the WsStore that tracks websockets & topics */
+    getWsStore(): typeof this.wsStore;
+    close(wsKey: WsKey, force?: boolean): void;
+    closeAll(force?: boolean): void;
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+     */
+    connectAll(): Promise<WebSocket | undefined>[];
+    /**
+     * Request connection to a specific websocket, instead of waiting for automatic connection.
+     */
+    private connect;
+    private parseWsError;
+    /** Get a signature, build the auth request and send it */
+    private sendAuthRequest;
+    private reconnectWithDelay;
+    private ping;
+    private clearTimers;
+    private clearPingTimer;
+    private clearPongTimer;
+    /**
+     * @private Use the `subscribe(topics)` method to subscribe to topics. Send WS message to subscribe to topics.
+     */
+    private requestSubscribeTopics;
+    /**
+     * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
+     */
+    private requestUnsubscribeTopics;
+    tryWsSend(wsKey: WsKey, wsMessage: string): void;
+    private connectToWsUrl;
+    private onWsOpen;
+    /** Handle subscription to private topics _after_ authentication successfully completes asynchronously */
+    private onWsAuthenticated;
+    private onWsMessage;
+    private onWsClose;
+    private getWs;
+    private setWsState;
+    private getWsUrl;
+    /**
+     * Subscribe to a topic
+     * @param instType instrument type (refer to API docs).
+     * @param topic topic name (e.g. "ticker").
+     * @param instId instrument ID (e.g. "BTCUSDT"). Use "default" for private topics.
+     */
+    subscribeTopic(instType: BitgetInstType, topic: WsTopic, instId?: string): void;
+    /**
+     * Unsubscribe from a topic
+     * @param instType instrument type (refer to API docs).
+     * @param topic topic name (e.g. "ticker").
+     * @param instId instrument ID (e.g. "BTCUSDT"). Use "default" for private topics to get all symbols.
+     */
+    unsubscribeTopic(instType: BitgetInstType, topic: WsTopic, instId?: string): void;
+}
+export {};