bitget-api 0.0.1 → 1.0.0

package/lib/types/websockets/client.d.ts

@@ -0,0 +1,37 @@
+import { WS_KEY_MAP } from '../../util';
+export declare type WsPublicSpotTopic = 'ticker' | 'candle1W' | 'candle1D' | 'candle12H' | 'candle4H' | 'candle1H' | 'candle30m' | 'candle15m' | 'candle5m' | 'candle1m' | 'books' | 'books5' | 'trade';
+export declare type WsPublicFuturesTopic = WsPublicSpotTopic;
+export declare type WsPrivateSpotTopic = 'account' | 'orders';
+export declare type WsPrivateFuturesTopic = 'account' | 'positions' | 'orders' | 'ordersAlgo';
+export declare type WsPublicTopic = WsPublicSpotTopic | WsPublicFuturesTopic;
+export declare type WsPrivateTopic = WsPrivateSpotTopic | WsPrivateFuturesTopic;
+export declare type WsTopic = WsPublicTopic | WsPrivateTopic;
+/** This is used to differentiate between each of the available websocket streams */
+export declare type WsKey = typeof WS_KEY_MAP[keyof typeof WS_KEY_MAP];
+export interface WSClientConfigurableOptions {
+    /** 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;
+    /** How often to check if the connection is alive */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    requestOptions?: {
+        /** override the user agent when opening the websocket connection (some proxies use this) */
+        agent?: string;
+    };
+    wsUrl?: string;
+    /** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
+    recvWindow?: number;
+}
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    pingInterval: number;
+    pongTimeout: number;
+    reconnectTimeout: number;
+    recvWindow: number;
+}

package/lib/types/websockets/client.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=client.js.map

package/lib/types/websockets/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/types/websockets/client.ts"],"names":[],"mappings":""}

package/lib/types/websockets/events.d.ts

@@ -0,0 +1,75 @@
+export interface WsBaseEvent<TAction = 'snapshot' | string, TData = unknown> {
+    action: TAction;
+    arg: unknown;
+    data: TData[];
+}
+export interface WsSnapshotChannelEvent extends WsBaseEvent<'snapshot'> {
+    arg: {
+        instType: string;
+        channel: string;
+        instId: string;
+    };
+}
+export interface WsSnapshotAccountEvent extends WsBaseEvent<'snapshot'> {
+    arg: {
+        instType: string;
+        channel: 'account';
+        instId: string;
+    };
+}
+export interface WsSnapshotPositionsEvent extends WsBaseEvent<'snapshot'> {
+    arg: {
+        instType: string;
+        channel: 'positions';
+        instId: string;
+    };
+}
+export interface WsAccountSnapshotUMCBL extends WsBaseEvent<'snapshot'> {
+    arg: {
+        instType: 'umcbl';
+        channel: 'account';
+        instId: string;
+    };
+    data: WsAccountSnapshotDataUMCBL[];
+}
+export interface WsAccountSnapshotDataUMCBL {
+    marginCoin: string;
+    locked: string;
+    available: string;
+    maxOpenPosAvailable: string;
+    maxTransferOut: string;
+    equity: string;
+    usdtEquity: string;
+}
+export interface WSPositionSnapshotUMCBL extends WsBaseEvent<'snapshot'> {
+    arg: {
+        instType: 'umcbl';
+        channel: 'positions';
+        instId: string;
+    };
+    data: WsPositionSnapshotDataUMCBL[];
+}
+export interface WsPositionSnapshotDataUMCBL {
+    posId: string;
+    instId: string;
+    instName: string;
+    marginCoin: string;
+    margin: string;
+    marginMode: string;
+    holdSide: string;
+    holdMode: string;
+    total: string;
+    available: string;
+    locked: string;
+    averageOpenPrice: string;
+    leverage: number;
+    achievedProfits: string;
+    upl: string;
+    uplRate: string;
+    liqPx: string;
+    keepMarginRate: string;
+    marginRate: string;
+    cTime: string;
+    uTime: string;
+    markPrice: string;
+}

package/lib/types/websockets/events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=events.js.map

package/lib/types/websockets/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/types/websockets/events.ts"],"names":[],"mappings":""}

package/lib/types/websockets/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client';
+export * from './events';

package/lib/types/websockets/index.js

@@ -0,0 +1,19 @@
+"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("./client"), exports);
+__exportStar(require("./events"), exports);
+//# sourceMappingURL=index.js.map

package/lib/types/websockets/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/websockets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,2CAAyB"}

package/lib/util/BaseRestClient.d.ts

@@ -0,0 +1,40 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestClientType } from '../types';
+import { RestClientOptions } from './requestUtils';
+export default abstract class BaseRestClient {
+    private options;
+    private baseUrl;
+    private globalRequestOptions;
+    private apiKey;
+    private apiSecret;
+    private clientType;
+    private apiPass;
+    /** Defines the client type (affecting how requests & signatures behave) */
+    abstract getClientType(): RestClientType;
+    /**
+     * Create an instance of the REST client. Pass API credentials in the object in the first parameter.
+     * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
+     * @param {AxiosRequestConfig} [networkOptions={}] HTTP networking options for axios
+     */
+    constructor(restOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig);
+    get(endpoint: string, params?: any): Promise<any>;
+    getPrivate(endpoint: string, params?: any): Promise<any>;
+    post(endpoint: string, params?: any): Promise<any>;
+    postPrivate(endpoint: string, params?: any): Promise<any>;
+    deletePrivate(endpoint: string, params?: any): Promise<any>;
+    /**
+     * @private Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
+     */
+    private _call;
+    /**
+     * @private generic handler to parse request exceptions
+     */
+    parseException(e: any): unknown;
+    /**
+     * @private sign request and set recv window
+     */
+    private signRequest;
+    private prepareSignParams;
+    /** Returns an axios request object. Handles signing process automatically if this is a private API call */
+    private buildRequest;
+}

package/lib/util/BaseRestClient.js

@@ -0,0 +1,195 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const node_support_1 = require("./node-support");
+const requestUtils_1 = require("./requestUtils");
+class BaseRestClient {
+    /**
+     * Create an instance of the REST client. Pass API credentials in the object in the first parameter.
+     * @param {RestClientOptions} [restClientOptions={}] options to configure REST API connectivity
+     * @param {AxiosRequestConfig} [networkOptions={}] HTTP networking options for axios
+     */
+    constructor(restOptions = {}, networkOptions = {}) {
+        this.clientType = this.getClientType();
+        this.options = Object.assign({ recvWindow: 5000, 
+            /** Throw errors if any request params are empty */
+            strictParamValidation: false }, restOptions);
+        this.globalRequestOptions = Object.assign(Object.assign({ 
+            // in ms == 5 minutes by default
+            timeout: 1000 * 60 * 5 }, networkOptions), { headers: {
+                'X-CHANNEL-CODE': '3tem',
+                'Content-Type': 'application/json',
+                locale: 'en-US',
+            } });
+        this.baseUrl = (0, requestUtils_1.getRestBaseUrl)(false, restOptions);
+        this.apiKey = this.options.apiKey;
+        this.apiSecret = this.options.apiSecret;
+        this.apiPass = this.options.apiPass;
+        // Throw if one of the 3 values is missing, but at least one of them is set
+        const credentials = [this.apiKey, this.apiSecret, this.apiPass];
+        if (credentials.includes(undefined) &&
+            credentials.some((v) => typeof v === 'string')) {
+            throw new Error('API Key, Secret & Passphrase are ALL required to use the authenticated REST client');
+        }
+    }
+    get(endpoint, params) {
+        return this._call('GET', endpoint, params, true);
+    }
+    getPrivate(endpoint, params) {
+        return this._call('GET', endpoint, params, false);
+    }
+    post(endpoint, params) {
+        return this._call('POST', endpoint, params, true);
+    }
+    postPrivate(endpoint, params) {
+        return this._call('POST', endpoint, params, false);
+    }
+    deletePrivate(endpoint, params) {
+        return this._call('DELETE', endpoint, params, false);
+    }
+    /**
+     * @private Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
+     */
+    _call(method, endpoint, params, isPublicApi) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Sanity check to make sure it's only ever prefixed by one forward slash
+            const requestUrl = [this.baseUrl, endpoint].join(endpoint.startsWith('/') ? '' : '/');
+            // Build a request and handle signature process
+            const options = yield this.buildRequest(method, endpoint, requestUrl, params, isPublicApi);
+            // console.log('full request: ', options);
+            // Dispatch request
+            return (0, axios_1.default)(options)
+                .then((response) => {
+                var _a, _b;
+                // console.log('response: ', response.data);
+                // console.error('res: ', response);
+                // if (response.data && response.data?.code !== API_ERROR_CODE.SUCCESS) {
+                //   throw response.data;
+                // }
+                if (response.status == 200) {
+                    if (typeof ((_a = response.data) === null || _a === void 0 ? void 0 : _a.code) === 'string' &&
+                        ((_b = response.data) === null || _b === void 0 ? void 0 : _b.code) !== '00000') {
+                        throw { response };
+                    }
+                    return response.data;
+                }
+                throw { response };
+            })
+                .catch((e) => this.parseException(e));
+        });
+    }
+    /**
+     * @private generic handler to parse request exceptions
+     */
+    parseException(e) {
+        if (this.options.parseExceptions === false) {
+            throw e;
+        }
+        // Something happened in setting up the request that triggered an Error
+        if (!e.response) {
+            if (!e.request) {
+                throw e.message;
+            }
+            // request made but no response received
+            throw e;
+        }
+        // The request was made and the server responded with a status code
+        // that falls out of the range of 2xx
+        const response = e.response;
+        // console.error('err: ', response?.data);
+        throw {
+            code: response.status,
+            message: response.statusText,
+            body: response.data,
+            headers: response.headers,
+            requestOptions: Object.assign(Object.assign({}, this.options), { apiPass: 'omittedFromError', apiSecret: 'omittedFromError' }),
+        };
+    }
+    /**
+     * @private sign request and set recv window
+     */
+    signRequest(data, endpoint, method, signMethod) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const timestamp = Date.now();
+            const res = {
+                originalParams: Object.assign({}, data),
+                sign: '',
+                timestamp,
+                recvWindow: 0,
+                serializedParams: '',
+                queryParamsWithSign: '',
+            };
+            if (!this.apiKey || !this.apiSecret) {
+                return res;
+            }
+            // It's possible to override the recv window on a per rquest level
+            const strictParamValidation = this.options.strictParamValidation;
+            if (signMethod === 'bitget') {
+                const signRequestParams = method === 'GET'
+                    ? (0, requestUtils_1.serializeParams)(data, strictParamValidation, '?')
+                    : JSON.stringify(data) || '';
+                const paramsStr = timestamp + method.toUpperCase() + endpoint + signRequestParams;
+                // console.log('sign params: ', paramsStr);
+                res.sign = yield (0, node_support_1.signMessage)(paramsStr, this.apiSecret, 'base64');
+                res.queryParamsWithSign = signRequestParams;
+                return res;
+            }
+            return res;
+        });
+    }
+    prepareSignParams(method, endpoint, signMethod, params, isPublicApi) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (isPublicApi) {
+                return {
+                    originalParams: params,
+                    paramsWithSign: params,
+                };
+            }
+            if (!this.apiKey || !this.apiSecret) {
+                throw new Error('Private endpoints require api and private keys set');
+            }
+            return this.signRequest(params, endpoint, method, signMethod);
+        });
+    }
+    /** Returns an axios request object. Handles signing process automatically if this is a private API call */
+    buildRequest(method, endpoint, url, params, isPublicApi) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = Object.assign(Object.assign({}, this.globalRequestOptions), { url: url, method: method });
+            for (const key in params) {
+                if (typeof params[key] === 'undefined') {
+                    delete params[key];
+                }
+            }
+            if (isPublicApi || !this.apiKey || !this.apiPass) {
+                return Object.assign(Object.assign({}, options), { params: params });
+            }
+            const signResult = yield this.prepareSignParams(method, endpoint, 'bitget', params, isPublicApi);
+            if (!options.headers) {
+                options.headers = {};
+            }
+            options.headers['ACCESS-KEY'] = this.apiKey;
+            options.headers['ACCESS-PASSPHRASE'] = this.apiPass;
+            options.headers['ACCESS-TIMESTAMP'] = signResult.timestamp;
+            options.headers['ACCESS-SIGN'] = signResult.sign;
+            options.headers['Content-Type'] = 'application/json';
+            if (method === 'GET') {
+                return Object.assign(Object.assign({}, options), { url: options.url + signResult.queryParamsWithSign });
+            }
+            return Object.assign(Object.assign({}, options), { data: params });
+        });
+    }
+}
+exports.default = BaseRestClient;
+//# sourceMappingURL=BaseRestClient.js.map

package/lib/util/BaseRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kDAAyE;AAIzE,iDAA6C;AAC7C,iDAIwB;AA2CxB,MAA8B,cAAc;IAY1C;;;;OAIG;IACH,YACE,cAAiC,EAAE,EACnC,iBAAqC,EAAE;QAEvC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAEvC,IAAI,CAAC,OAAO,mBACV,UAAU,EAAE,IAAI;YAChB,mDAAmD;YACnD,qBAAqB,EAAE,KAAK,IACzB,WAAW,CACf,CAAC;QAEF,IAAI,CAAC,oBAAoB;YACvB,gCAAgC;YAChC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,IAEnB,cAAc,KACjB,OAAO,EAAE;gBACP,gBAAgB,EAAE,MAAM;gBACxB,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,OAAO;aAChB,GACF,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,IAAA,6BAAc,EAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;QAEpC,2EAA2E;QAC3E,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAChE,IACE,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC/B,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAC9C;YACA,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;SACH;IACH,CAAC;IAED,GAAG,CAAC,QAAgB,EAAE,MAAY;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,UAAU,CAAC,QAAgB,EAAE,MAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,CAAC,QAAgB,EAAE,MAAY;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,WAAW,CAAC,QAAgB,EAAE,MAAY;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,aAAa,CAAC,QAAgB,EAAE,MAAY;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACW,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAY,EACZ,WAAqB;;YAErB,yEAAyE;YACzE,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAC9C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CACpC,CAAC;YAEF,+CAA+C;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CACrC,MAAM,EACN,QAAQ,EACR,UAAU,EACV,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,0CAA0C;YAE1C,mBAAmB;YACnB,OAAO,IAAA,eAAK,EAAC,OAAO,CAAC;iBAClB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;;gBACjB,4CAA4C;gBAC5C,oCAAoC;gBACpC,yEAAyE;gBACzE,yBAAyB;gBACzB,IAAI;gBACJ,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;oBAC1B,IACE,OAAO,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,CAAA,KAAK,QAAQ;wBACvC,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,MAAK,OAAO,EAC/B;wBACA,MAAM,EAAE,QAAQ,EAAE,CAAC;qBACpB;oBACD,OAAO,QAAQ,CAAC,IAAI,CAAC;iBACtB;gBACD,MAAM,EAAE,QAAQ,EAAE,CAAC;YACrB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACH,cAAc,CAAC,CAAM;QACnB,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,KAAK,KAAK,EAAE;YAC1C,MAAM,CAAC,CAAC;SACT;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,MAAM,CAAC,CAAC,OAAO,CAAC;aACjB;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;SACT;QAED,mEAAmE;QACnE,qCAAqC;QACrC,MAAM,QAAQ,GAAkB,CAAC,CAAC,QAAQ,CAAC;QAC3C,0CAA0C;QAE1C,MAAM;YACJ,IAAI,EAAE,QAAQ,CAAC,MAAM;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU;YAC5B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,cAAc,kCACT,IAAI,CAAC,OAAO,KACf,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,kBAAkB,GAC9B;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACW,WAAW,CACvB,IAAO,EACP,QAAgB,EAChB,MAAc,EACd,UAAsB;;YAEtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,MAAM,GAAG,GAAqB;gBAC5B,cAAc,oBACT,IAAI,CACR;gBACD,IAAI,EAAE,EAAE;gBACR,SAAS;gBACT,UAAU,EAAE,CAAC;gBACb,gBAAgB,EAAE,EAAE;gBACpB,mBAAmB,EAAE,EAAE;aACxB,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnC,OAAO,GAAG,CAAC;aACZ;YAED,kEAAkE;YAClE,MAAM,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC;YAEjE,IAAI,UAAU,KAAK,QAAQ,EAAE;gBAC3B,MAAM,iBAAiB,GACrB,MAAM,KAAK,KAAK;oBACd,CAAC,CAAC,IAAA,8BAAe,EAAC,IAAI,EAAE,qBAAqB,EAAE,GAAG,CAAC;oBACnD,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAEjC,MAAM,SAAS,GACb,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,QAAQ,GAAG,iBAAiB,CAAC;gBAElE,2CAA2C;gBAE3C,GAAG,CAAC,IAAI,GAAG,MAAM,IAAA,0BAAW,EAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBAClE,GAAG,CAAC,mBAAmB,GAAG,iBAAiB,CAAC;gBAC5C,OAAO,GAAG,CAAC;aACZ;YAED,OAAO,GAAG,CAAC;QACb,CAAC;KAAA;IAgBa,iBAAiB,CAC7B,MAAc,EACd,QAAgB,EAChB,UAAsB,EACtB,MAAgB,EAChB,WAAqB;;YAErB,IAAI,WAAW,EAAE;gBACf,OAAO;oBACL,cAAc,EAAE,MAAM;oBACtB,cAAc,EAAE,MAAM;iBACvB,CAAC;aACH;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YAED,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAChE,CAAC;KAAA;IAED,2GAA2G;IAC7F,YAAY,CACxB,MAAc,EACd,QAAgB,EAChB,GAAW,EACX,MAAY,EACZ,WAAqB;;YAErB,MAAM,OAAO,mCACR,IAAI,CAAC,oBAAoB,KAC5B,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,GACf,CAAC;YAEF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;aACF;YAED,IAAI,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBAChD,uCACK,OAAO,KACV,MAAM,EAAE,MAAM,IACd;aACH;YAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC7C,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBACpB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;aACtB;YACD,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;YAC5C,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;YACpD,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC;YAC3D,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;YACjD,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAErD,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,uCACK,OAAO,KACV,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC,mBAAmB,IACjD;aACH;YAED,uCACK,OAAO,KACV,IAAI,EAAE,MAAM,IACZ;QACJ,CAAC;KAAA;CACF;AA7SD,iCA6SC"}

package/lib/util/WsStore.d.ts

@@ -0,0 +1,62 @@
+import WebSocket from 'isomorphic-ws';
+import { WsTopic } from '../types';
+import { DefaultLogger } from './logger';
+export declare enum WsConnectionStateEnum {
+    INITIAL = 0,
+    CONNECTING = 1,
+    CONNECTED = 2,
+    CLOSING = 3,
+    RECONNECTING = 4
+}
+/** A "topic" is always a string */
+export declare type BitgetInstType = 'SP' | 'SPBL' | 'MC' | 'UMCBL' | 'DMCBL';
+export interface WsTopicSubscribeEventArgs {
+    instType: BitgetInstType;
+    channel: WsTopic;
+    /** The symbol, e.g. "BTCUSDT" */
+    instId: string;
+}
+declare type WsTopicList = Set<WsTopicSubscribeEventArgs>;
+interface WsStoredState {
+    /** The currently active websocket connection */
+    ws?: WebSocket;
+    /** The current lifecycle state of the connection (enum) */
+    connectionState?: WsConnectionStateEnum;
+    /** A timer that will send an upstream heartbeat (ping) when it expires */
+    activePingTimer?: ReturnType<typeof setTimeout> | undefined;
+    /** A timer tracking that an upstream heartbeat was sent, expecting a reply before it expires */
+    activePongTimer?: ReturnType<typeof setTimeout> | undefined;
+    /** If a reconnection is in progress, this will have the timer for the delayed reconnect */
+    activeReconnectTimer?: ReturnType<typeof setTimeout> | undefined;
+    /**
+     * All the topics we are expected to be subscribed to (and we automatically resubscribe to if the connection drops)
+     *
+     * A "Set" and a deep object match are used to ensure we only subscribe to a topic once (tracking a list of unique topics we're expected to be connected to)
+     */
+    subscribedTopics: WsTopicList;
+    isAuthenticated?: boolean;
+}
+export default class WsStore<WsKey extends string> {
+    private wsState;
+    private logger;
+    constructor(logger: typeof DefaultLogger);
+    /** Get WS stored state for key, optionally create if missing */
+    get(key: WsKey, createIfMissing?: true): WsStoredState;
+    get(key: WsKey, createIfMissing?: false): WsStoredState | undefined;
+    getKeys(): WsKey[];
+    create(key: WsKey): WsStoredState | undefined;
+    delete(key: WsKey): void;
+    hasExistingActiveConnection(key: WsKey): boolean;
+    getWs(key: WsKey): WebSocket | undefined;
+    setWs(key: WsKey, wsConnection: WebSocket): WebSocket;
+    isWsOpen(key: WsKey): boolean;
+    getConnectionState(key: WsKey): WsConnectionStateEnum;
+    setConnectionState(key: WsKey, state: WsConnectionStateEnum): void;
+    isConnectionState(key: WsKey, state: WsConnectionStateEnum): boolean;
+    getTopics(key: WsKey): WsTopicList;
+    getTopicsByKey(): Record<string, WsTopicList>;
+    getMatchingTopic(key: WsKey, topic: WsTopicSubscribeEventArgs): WsTopicSubscribeEventArgs | undefined;
+    addTopic(key: WsKey, topic: WsTopicSubscribeEventArgs): WsTopicList;
+    deleteTopic(key: WsKey, topic: WsTopicSubscribeEventArgs): WsTopicList;
+}
+export {};

package/lib/util/WsStore.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsConnectionStateEnum = void 0;
+const logger_1 = require("./logger");
+var WsConnectionStateEnum;
+(function (WsConnectionStateEnum) {
+    WsConnectionStateEnum[WsConnectionStateEnum["INITIAL"] = 0] = "INITIAL";
+    WsConnectionStateEnum[WsConnectionStateEnum["CONNECTING"] = 1] = "CONNECTING";
+    WsConnectionStateEnum[WsConnectionStateEnum["CONNECTED"] = 2] = "CONNECTED";
+    WsConnectionStateEnum[WsConnectionStateEnum["CLOSING"] = 3] = "CLOSING";
+    WsConnectionStateEnum[WsConnectionStateEnum["RECONNECTING"] = 4] = "RECONNECTING";
+    // ERROR = 5,
+})(WsConnectionStateEnum = exports.WsConnectionStateEnum || (exports.WsConnectionStateEnum = {}));
+function isDeepObjectMatch(object1, object2) {
+    for (const key in object1) {
+        if (object1[key] !== object2[key]) {
+            return false;
+        }
+    }
+    return true;
+}
+class WsStore {
+    constructor(logger) {
+        this.wsState = {};
+        this.logger = logger || logger_1.DefaultLogger;
+    }
+    get(key, createIfMissing) {
+        if (this.wsState[key]) {
+            return this.wsState[key];
+        }
+        if (createIfMissing) {
+            return this.create(key);
+        }
+    }
+    getKeys() {
+        return Object.keys(this.wsState);
+    }
+    create(key) {
+        if (this.hasExistingActiveConnection(key)) {
+            this.logger.warning('WsStore setConnection() overwriting existing open connection: ', this.getWs(key));
+        }
+        this.wsState[key] = {
+            subscribedTopics: new Set(),
+            connectionState: WsConnectionStateEnum.INITIAL,
+        };
+        return this.get(key);
+    }
+    delete(key) {
+        // TODO: should we allow this at all? Perhaps block this from happening...
+        if (this.hasExistingActiveConnection(key)) {
+            const ws = this.getWs(key);
+            this.logger.warning('WsStore deleting state for connection still open: ', ws);
+            ws === null || ws === void 0 ? void 0 : ws.close();
+        }
+        delete this.wsState[key];
+    }
+    /* connection websocket */
+    hasExistingActiveConnection(key) {
+        return this.get(key) && this.isWsOpen(key);
+    }
+    getWs(key) {
+        var _a;
+        return (_a = this.get(key)) === null || _a === void 0 ? void 0 : _a.ws;
+    }
+    setWs(key, wsConnection) {
+        if (this.isWsOpen(key)) {
+            this.logger.warning('WsStore setConnection() overwriting existing open connection: ', this.getWs(key));
+        }
+        this.get(key, true).ws = wsConnection;
+        return wsConnection;
+    }
+    /* connection state */
+    isWsOpen(key) {
+        const existingConnection = this.getWs(key);
+        return (!!existingConnection &&
+            existingConnection.readyState === existingConnection.OPEN);
+    }
+    getConnectionState(key) {
+        return this.get(key, true).connectionState;
+    }
+    setConnectionState(key, state) {
+        this.get(key, true).connectionState = state;
+    }
+    isConnectionState(key, state) {
+        return this.getConnectionState(key) === state;
+    }
+    /* subscribed topics */
+    getTopics(key) {
+        return this.get(key, true).subscribedTopics;
+    }
+    getTopicsByKey() {
+        const result = {};
+        for (const refKey in this.wsState) {
+            result[refKey] = this.getTopics(refKey);
+        }
+        return result;
+    }
+    // Since topics are objects we can't rely on the set to detect duplicates
+    getMatchingTopic(key, topic) {
+        // if (typeof topic === 'string') {
+        //   return this.getMatchingTopic(key, { channel: topic });
+        // }
+        const allTopics = this.getTopics(key).values();
+        for (const storedTopic of allTopics) {
+            if (isDeepObjectMatch(topic, storedTopic)) {
+                return storedTopic;
+            }
+        }
+    }
+    addTopic(key, topic) {
+        // if (typeof topic === 'string') {
+        //   return this.addTopic(key, {
+        //     instType: 'sp',
+        //     channel: topic,
+        //     instId: 'default',
+        //   };
+        // }
+        // Check for duplicate topic. If already tracked, don't store this one
+        const existingTopic = this.getMatchingTopic(key, topic);
+        if (existingTopic) {
+            return this.getTopics(key);
+        }
+        return this.getTopics(key).add(topic);
+    }
+    deleteTopic(key, topic) {
+        // Check if we're subscribed to a topic like this
+        const storedTopic = this.getMatchingTopic(key, topic);
+        if (storedTopic) {
+            this.getTopics(key).delete(storedTopic);
+        }
+        return this.getTopics(key);
+    }
+}
+exports.default = WsStore;
+//# sourceMappingURL=WsStore.js.map

package/lib/util/WsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WsStore.js","sourceRoot":"","sources":["../../src/util/WsStore.ts"],"names":[],"mappings":";;;AAEA,qCAAyC;AAEzC,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,6EAAc,CAAA;IACd,2EAAa,CAAA;IACb,uEAAW,CAAA;IACX,iFAAgB,CAAA;IAChB,aAAa;AACf,CAAC,EAPW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAOhC;AAmCD,SAAS,iBAAiB,CAAC,OAAY,EAAE,OAAY;IACnD,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;QACzB,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAqB,OAAO;IAI1B,YAAY,MAA4B;QAHhC,YAAO,GAAkC,EAAE,CAAC;QAIlD,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,sBAAa,CAAC;IACxC,CAAC;IAKD,GAAG,CAAC,GAAU,EAAE,eAAyB;QACvC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,IAAI,eAAe,EAAE;YACnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;IACH,CAAC;IAED,OAAO;QACL,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAY,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,GAAU;QACf,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE;YACzC,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;SACH;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;YAClB,gBAAgB,EAAE,IAAI,GAAG,EAAE;YAC3B,eAAe,EAAE,qBAAqB,CAAC,OAAO;SAC/C,CAAC;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,GAAU;QACf,0EAA0E;QAC1E,IAAI,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE;YACzC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,oDAAoD,EACpD,EAAE,CACH,CAAC;YACF,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,EAAE,CAAC;SACb;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,0BAA0B;IAE1B,2BAA2B,CAAC,GAAU;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAU;;QACd,OAAO,MAAA,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,0CAAE,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,GAAU,EAAE,YAAuB;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CACjB,gEAAgE,EAChE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAChB,CAAC;SACH;QAED,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC;QACtC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,sBAAsB;IAEtB,QAAQ,CAAC,GAAU;QACjB,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,OAAO,CACL,CAAC,CAAC,kBAAkB;YACpB,kBAAkB,CAAC,UAAU,KAAK,kBAAkB,CAAC,IAAI,CAC1D,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,GAAU;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,eAAgB,CAAC;IAC9C,CAAC;IAED,kBAAkB,CAAC,GAAU,EAAE,KAA4B;QACzD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,eAAe,GAAG,KAAK,CAAC;IAC9C,CAAC;IAED,iBAAiB,CAAC,GAAU,EAAE,KAA4B;QACxD,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;IAChD,CAAC;IAED,uBAAuB;IAEvB,SAAS,CAAC,GAAU;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,gBAAgB,CAAC;IAC9C,CAAC;IAED,cAAc;QACZ,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YACjC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAe,CAAC,CAAC;SAClD;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,yEAAyE;IACzE,gBAAgB,CAAC,GAAU,EAAE,KAAgC;QAC3D,mCAAmC;QACnC,2DAA2D;QAC3D,IAAI;QAEJ,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QAC/C,KAAK,MAAM,WAAW,IAAI,SAAS,EAAE;YACnC,IAAI,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE;gBACzC,OAAO,WAAW,CAAC;aACpB;SACF;IACH,CAAC;IAED,QAAQ,CAAC,GAAU,EAAE,KAAgC;QACnD,mCAAmC;QACnC,gCAAgC;QAChC,sBAAsB;QACtB,sBAAsB;QACtB,yBAAyB;QACzB,OAAO;QACP,IAAI;QACJ,sEAAsE;QACtE,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxD,IAAI,aAAa,EAAE;YACjB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;SAC5B;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,WAAW,CAAC,GAAU,EAAE,KAAgC;QACtD,iDAAiD;QACjD,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtD,IAAI,WAAW,EAAE;YACf,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SACzC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;CACF;AArJD,0BAqJC"}

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

@@ -0,0 +1 @@
+export declare function signMessage(message: string, secret: string, method: 'hex' | 'base64'): Promise<string>;

package/lib/util/browser-support.js

@@ -0,0 +1,44 @@
+"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;
+function _arrayBufferToBase64(buffer) {
+    let binary = '';
+    const bytes = new Uint8Array(buffer);
+    const len = bytes.byteLength;
+    for (let i = 0; i < len; i++) {
+        binary += String.fromCharCode(bytes[i]);
+    }
+    return window.btoa(binary);
+}
+function signMessage(message, secret, method) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const encoder = new TextEncoder();
+        const key = yield window.crypto.subtle.importKey('raw', encoder.encode(secret), { name: 'HMAC', hash: { name: 'SHA-256' } }, false, ['sign']);
+        const signature = yield window.crypto.subtle.sign('HMAC', key, encoder.encode(message));
+        switch (method) {
+            case 'hex': {
+                return Array.prototype.map
+                    .call(new Uint8Array(signature), (x) => ('00' + x.toString(16)).slice(-2))
+                    .join('');
+            }
+            case 'base64': {
+                return _arrayBufferToBase64(signature);
+            }
+            default: {
+                ((x) => { })(method);
+                throw new Error(`Unhandled sign method: ${method}`);
+            }
+        }
+    });
+}
+exports.signMessage = signMessage;
+//# sourceMappingURL=browser-support.js.map