bitget-api 2.3.6 → 3.0.0

package/dist/cjs/util/BaseRestClient.js

@@ -0,0 +1,274 @@
+"use strict";
+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 https_1 = __importDefault(require("https"));
+const requestUtils_js_1 = require("./requestUtils.js");
+const webCryptoAPI_js_1 = require("./webCryptoAPI.js");
+const websocket_util_js_1 = require("./websocket-util.js");
+const ENABLE_HTTP_TRACE = typeof process === 'object' &&
+    typeof process.env === 'object' &&
+    process.env.BITGETTRACE;
+if (ENABLE_HTTP_TRACE) {
+    axios_1.default.interceptors.request.use((request) => {
+        console.log(new Date(), 'Starting Request', JSON.stringify({
+            url: request.url,
+            method: request.method,
+            params: request.params,
+            data: request.data,
+        }, null, 2));
+        return request;
+    });
+    axios_1.default.interceptors.response.use((response) => {
+        console.log(new Date(), 'Response:', {
+            // request: {
+            //   url: response.config.url,
+            //   method: response.config.method,
+            //   data: response.config.data,
+            //   headers: response.config.headers,
+            // },
+            response: {
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers,
+                data: response.data,
+            },
+        });
+        return response;
+    });
+}
+class BaseRestClient {
+    options;
+    baseUrl;
+    globalRequestOptions;
+    apiKey;
+    apiSecret;
+    apiPass;
+    /**
+     * 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.options = {
+            recvWindow: 5000,
+            /** Throw errors if any request params are empty */
+            strictParamValidation: false,
+            encodeQueryStringValues: true,
+            ...restOptions,
+        };
+        this.globalRequestOptions = {
+            /** in ms == 5 minutes by default */
+            timeout: 1000 * 60 * 5,
+            /** inject custom rquest options based on axios specs - see axios docs for more guidance on AxiosRequestConfig: https://github.com/axios/axios#request-config */
+            ...networkOptions,
+            headers: {
+                'X-CHANNEL-API-CODE': 'hbnni',
+                'Content-Type': 'application/json',
+                locale: 'en-US',
+            },
+        };
+        if (this.options.demoTrading) {
+            this.globalRequestOptions.headers = {
+                ...this.globalRequestOptions.headers,
+                // Header to enable paper trading with provided demo API keys
+                paptrading: '1',
+            };
+        }
+        // If enabled, configure a https agent with keepAlive enabled
+        if (this.options.keepAlive) {
+            // Extract existing https agent parameters, if provided, to prevent the keepAlive flag from overwriting an existing https agent completely
+            const existingHttpsAgent = this.globalRequestOptions.httpsAgent;
+            const existingAgentOptions = existingHttpsAgent?.options || {};
+            // For more advanced configuration, raise an issue on GitHub or use the "networkOptions"
+            // parameter to define a custom httpsAgent with the desired properties
+            this.globalRequestOptions.httpsAgent = new https_1.default.Agent({
+                ...existingAgentOptions,
+                keepAlive: true,
+                keepAliveMsecs: this.options.keepAliveMsecs,
+            });
+        }
+        this.baseUrl = (0, requestUtils_js_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 endpoint API calls are automatically signed.
+     */
+    async _call(method, endpoint, params, isPublicApi) {
+        // 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 = await this.buildRequest(method, endpoint, requestUrl, params, isPublicApi);
+        if (ENABLE_HTTP_TRACE) {
+            console.log('full request: ', options);
+        }
+        // Dispatch request
+        return (0, axios_1.default)(options)
+            .then((response) => {
+            if (response.status == 200) {
+                if (typeof response.data?.code === 'string' &&
+                    response.data?.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: {
+                ...this.options,
+                // Prevent credentials from leaking into error messages
+                apiPass: 'omittedFromError',
+                apiSecret: 'omittedFromError',
+            },
+        };
+    }
+    async signMessage(paramsStr, secret, method, algorithm) {
+        if (typeof this.options.customSignMessageFn === 'function') {
+            return this.options.customSignMessageFn(paramsStr, secret);
+        }
+        return await (0, webCryptoAPI_js_1.signMessage)(paramsStr, secret, method, algorithm);
+    }
+    /**
+     * @private sign request and set recv window
+     */
+    async signRequest(data, endpoint, method, signMethod) {
+        const timestamp = Date.now();
+        const res = {
+            originalParams: {
+                ...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;
+        const encodeQueryStringValues = this.options.encodeQueryStringValues;
+        if (signMethod === 'bitget') {
+            const signRequestParams = method === 'GET'
+                ? (0, requestUtils_js_1.serializeParams)(data, strictParamValidation, encodeQueryStringValues, '?')
+                : JSON.stringify(data) || '';
+            const paramsStr = timestamp + method.toUpperCase() + endpoint + signRequestParams;
+            // console.log('sign params: ', paramsStr);
+            res.sign = await this.signMessage(paramsStr, this.apiSecret, 'base64', 'SHA-256');
+            res.queryParamsWithSign = signRequestParams;
+            return res;
+        }
+        console.error(new Date(), (0, websocket_util_js_1.neverGuard)(signMethod, `Unhandled sign method: "${webCryptoAPI_js_1.signMessage}"`));
+        return res;
+    }
+    async prepareSignParams(method, endpoint, signMethod, params, isPublicApi) {
+        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 */
+    async buildRequest(method, endpoint, url, params, isPublicApi) {
+        const options = {
+            ...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 {
+                ...options,
+                params: params,
+            };
+        }
+        const signResult = await this.prepareSignParams(method, endpoint, 'bitget', params, isPublicApi);
+        const authHeaders = {
+            'ACCESS-KEY': this.apiKey,
+            'ACCESS-PASSPHRASE': this.apiPass,
+            'ACCESS-TIMESTAMP': signResult.timestamp,
+            'ACCESS-SIGN': signResult.sign,
+        };
+        if (method === 'GET') {
+            return {
+                ...options,
+                headers: {
+                    ...authHeaders,
+                    ...options.headers,
+                },
+                url: options.url + signResult.queryParamsWithSign,
+            };
+        }
+        return {
+            ...options,
+            headers: {
+                ...authHeaders,
+                ...options.headers,
+            },
+            data: params,
+        };
+    }
+}
+exports.default = BaseRestClient;
+//# sourceMappingURL=BaseRestClient.js.map

package/dist/cjs/util/BaseRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;AAAA,kDAAyE;AACzE,kDAA0B;AAG1B,uDAI2B;AAC3B,uDAI2B;AAC3B,2DAAiD;AAmBjD,MAAM,iBAAiB,GACrB,OAAO,OAAO,KAAK,QAAQ;IAC3B,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ;IAC/B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;AAE1B,IAAI,iBAAiB,EAAE,CAAC;IACtB,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACzC,OAAO,CAAC,GAAG,CACT,IAAI,IAAI,EAAE,EACV,kBAAkB,EAClB,IAAI,CAAC,SAAS,CACZ;YACE,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,EACD,IAAI,EACJ,CAAC,CACF,CACF,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,eAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,WAAW,EAAE;YACnC,aAAa;YACb,8BAA8B;YAC9B,oCAAoC;YACpC,gCAAgC;YAChC,sCAAsC;YACtC,KAAK;YACL,QAAQ,EAAE;gBACR,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB;SACF,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAA8B,cAAc;IAClC,OAAO,CAAoB;IAE3B,OAAO,CAAS;IAEhB,oBAAoB,CAAqB;IAEzC,MAAM,CAAqB;IAE3B,SAAS,CAAqB;IAE9B,OAAO,CAAqB;IAKpC;;;;OAIG;IACH,YACE,cAAiC,EAAE,EACnC,iBAAqC,EAAE;QAEvC,IAAI,CAAC,OAAO,GAAG;YACb,UAAU,EAAE,IAAI;YAChB,mDAAmD;YACnD,qBAAqB,EAAE,KAAK;YAC5B,uBAAuB,EAAE,IAAI;YAC7B,GAAG,WAAW;SACf,CAAC;QAEF,IAAI,CAAC,oBAAoB,GAAG;YAC1B,oCAAoC;YACpC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC;YACtB,gKAAgK;YAChK,GAAG,cAAc;YACjB,OAAO,EAAE;gBACP,oBAAoB,EAAE,OAAO;gBAC7B,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,OAAO;aAChB;SACF,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,oBAAoB,CAAC,OAAO,GAAG;gBAClC,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO;gBACpC,6DAA6D;gBAC7D,UAAU,EAAE,GAAG;aAChB,CAAC;QACJ,CAAC;QAED,6DAA6D;QAC7D,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC3B,0IAA0I;YAC1I,MAAM,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAExC,CAAC;YACd,MAAM,oBAAoB,GAAG,kBAAkB,EAAE,OAAO,IAAI,EAAE,CAAC;YAE/D,wFAAwF;YACxF,sEAAsE;YACtE,IAAI,CAAC,oBAAoB,CAAC,UAAU,GAAG,IAAI,eAAK,CAAC,KAAK,CAAC;gBACrD,GAAG,oBAAoB;gBACvB,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;aAC5C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAA,gCAAc,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,CAAC;YACD,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;QACJ,CAAC;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;IACK,KAAK,CAAC,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAY,EACZ,WAAqB;QAErB,yEAAyE;QACzE,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;QAEF,+CAA+C;QAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CACrC,MAAM,EACN,QAAQ,EACR,UAAU,EACV,MAAM,EACN,WAAW,CACZ,CAAC;QAEF,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC;QAED,mBAAmB;QACnB,OAAO,IAAA,eAAK,EAAC,OAAO,CAAC;aAClB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;gBAC3B,IACE,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,QAAQ;oBACvC,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,EAC/B,CAAC;oBACD,MAAM,EAAE,QAAQ,EAAE,CAAC;gBACrB,CAAC;gBACD,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC;YACD,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,CAAM;QACnB,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,KAAK,KAAK,EAAE,CAAC;YAC3C,MAAM,CAAC,CAAC;QACV,CAAC;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gBACf,MAAM,CAAC,CAAC,OAAO,CAAC;YAClB,CAAC;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;QACV,CAAC;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,EAAE;gBACd,GAAG,IAAI,CAAC,OAAO;gBACf,uDAAuD;gBACvD,OAAO,EAAE,kBAAkB;gBAC3B,SAAS,EAAE,kBAAkB;aAC9B;SACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,SAAiB,EACjB,MAAc,EACd,MAAwB,EACxB,SAAwB;QAExB,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,KAAK,UAAU,EAAE,CAAC;YAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,MAAM,IAAA,6BAAW,EAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,WAAW,CACvB,IAAO,EACP,QAAgB,EAChB,MAAc,EACd,UAAsB;QAEtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,MAAM,GAAG,GAAqB;YAC5B,cAAc,EAAE;gBACd,GAAG,IAAI;aACR;YACD,IAAI,EAAE,EAAE;YACR,SAAS;YACT,UAAU,EAAE,CAAC;YACb,gBAAgB,EAAE,EAAE;YACpB,mBAAmB,EAAE,EAAE;SACxB,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,OAAO,GAAG,CAAC;QACb,CAAC;QAED,kEAAkE;QAClE,MAAM,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC;QACjE,MAAM,uBAAuB,GAAG,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC;QAErE,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,iBAAiB,GACrB,MAAM,KAAK,KAAK;gBACd,CAAC,CAAC,IAAA,iCAAe,EACb,IAAI,EACJ,qBAAqB,EACrB,uBAAuB,EACvB,GAAG,CACJ;gBACH,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAEjC,MAAM,SAAS,GACb,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,QAAQ,GAAG,iBAAiB,CAAC;YAElE,2CAA2C;YAE3C,GAAG,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAC/B,SAAS,EACT,IAAI,CAAC,SAAS,EACd,QAAQ,EACR,SAAS,CACV,CAAC;YACF,GAAG,CAAC,mBAAmB,GAAG,iBAAiB,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,CAAC,KAAK,CACX,IAAI,IAAI,EAAE,EACV,IAAA,8BAAU,EAAC,UAAU,EAAE,2BAA2B,6BAAW,GAAG,CAAC,CAClE,CAAC;QAEF,OAAO,GAAG,CAAC;IACb,CAAC;IAkBO,KAAK,CAAC,iBAAiB,CAC7B,MAAc,EACd,QAAgB,EAChB,UAAsB,EACtB,MAAgB,EAChB,WAAqB;QAErB,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO;gBACL,cAAc,EAAE,MAAM;gBACtB,cAAc,EAAE,MAAM;aACvB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAED,2GAA2G;IACnG,KAAK,CAAC,YAAY,CACxB,MAAc,EACd,QAAgB,EAChB,GAAW,EACX,MAAY,EACZ,WAAqB;QAErB,MAAM,OAAO,GAAuB;YAClC,GAAG,IAAI,CAAC,oBAAoB;YAC5B,GAAG,EAAE,GAAG;YACR,MAAM,EAAE,MAAM;SACf,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE,CAAC;gBACvC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QAED,IAAI,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACjD,OAAO;gBACL,GAAG,OAAO;gBACV,MAAM,EAAE,MAAM;aACf,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC7C,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,WAAW,CACZ,CAAC;QAEF,MAAM,WAAW,GAAG;YAClB,YAAY,EAAE,IAAI,CAAC,MAAM;YACzB,mBAAmB,EAAE,IAAI,CAAC,OAAO;YACjC,kBAAkB,EAAE,UAAU,CAAC,SAAS;YACxC,aAAa,EAAE,UAAU,CAAC,IAAI;SAC/B,CAAC;QAEF,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,OAAO;gBACL,GAAG,OAAO;gBACV,OAAO,EAAE;oBACP,GAAG,WAAW;oBACd,GAAG,OAAO,CAAC,OAAO;iBACnB;gBACD,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC,mBAAmB;aAClD,CAAC;QACJ,CAAC;QAED,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,WAAW;gBACd,GAAG,OAAO,CAAC,OAAO;aACnB;YACD,IAAI,EAAE,MAAM;SACb,CAAC;IACJ,CAAC;CACF;AA3WD,iCA2WC"}

package/dist/cjs/util/BaseWSClient.d.ts

@@ -0,0 +1,197 @@
+import EventEmitter from 'events';
+import WebSocket from 'isomorphic-ws';
+import { WSOperation } from '../types/websockets/ws-api.js';
+import { MessageEventLike } from '../types/websockets/ws-events.js';
+import { WebsocketClientOptions, WSClientConfigurableOptions } from '../types/websockets/ws-general.js';
+import { DefaultLogger } from './logger.js';
+import { WsTopicRequest, WsTopicRequestOrStringTopic } from './websocket-util.js';
+import WsStore from './WsStore.js';
+import { WSConnectedResult } from './WsStore.types.js';
+interface WSClientEventMap<WsKey extends string> {
+    /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
+    open: (evt: {
+        wsKey: WsKey;
+        event: any;
+        wsUrl: string;
+        ws: WebSocket;
+    }) => void;
+    /** Reconnecting a dropped connection */
+    reconnect: (evt: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+    /** Successfully reconnected a connection that dropped */
+    reconnected: (evt: {
+        wsKey: WsKey;
+        event: any;
+        wsUrl: string;
+        ws: WebSocket;
+    }) => 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 interface BaseWebsocketClient<TWSKey extends string, TWSRequestEvent extends object> {
+    on<U extends keyof WSClientEventMap<TWSKey>>(event: U, listener: WSClientEventMap<TWSKey>[U]): this;
+    emit<U extends keyof WSClientEventMap<TWSKey>>(event: U, ...args: Parameters<WSClientEventMap<TWSKey>[U]>): boolean;
+}
+export interface EmittableEvent<TEvent = any> {
+    eventType: 'response' | 'update' | 'exception' | 'authenticated';
+    event: TEvent;
+    isWSAPIResponse?: boolean;
+}
+/**
+ * A midflight WS request event (e.g. subscribe to these topics).
+ *
+ * - requestKey: unique identifier for this request, if available. Can be anything as a string.
+ * - requestEvent: the raw request, as an object, that will be sent on the ws connection. This may contain multiple topics/requests in one object, if the exchange supports it.
+ */
+export interface MidflightWsRequestEvent<TEvent = object> {
+    requestKey: string;
+    requestEvent: TEvent;
+}
+export declare abstract class BaseWebsocketClient<TWSKey extends string, TWSRequestEvent extends object> extends EventEmitter {
+    /**
+     * State store to track a list of topics (topic requests) we are expected to be subscribed to if reconnected
+     */
+    private wsStore;
+    logger: DefaultLogger;
+    protected options: WebsocketClientOptions;
+    private wsApiRequestId;
+    private timeOffsetMs;
+    /**
+     * { [wsKey]: { [requestId]: request } }
+     */
+    private midflightRequestCache;
+    constructor(options?: WSClientConfigurableOptions, logger?: DefaultLogger);
+    /**
+     * Return true if this wsKey connection should automatically authenticate immediately after connecting
+     */
+    protected abstract isAuthOnConnectWsKey(wsKey: TWSKey): boolean;
+    protected abstract sendPingEvent(wsKey: TWSKey, ws: WebSocket): void;
+    protected abstract sendPongEvent(wsKey: TWSKey, ws: WebSocket): void;
+    protected abstract isWsPing(data: any): boolean;
+    protected abstract isWsPong(data: any): boolean;
+    protected abstract getWsAuthRequestEvent(wsKey: TWSKey): Promise<object>;
+    protected abstract isPrivateTopicRequest(request: WsTopicRequest<string>, wsKey: TWSKey): boolean;
+    protected abstract getPrivateWSKeys(): TWSKey[];
+    protected abstract getWsUrl(wsKey: TWSKey): Promise<string>;
+    protected abstract getMaxTopicsPerSubscribeEvent(wsKey: TWSKey): number | null;
+    /**
+     * @returns one or more correctly structured request events for performing a operations over WS. This can vary per exchange spec.
+     */
+    protected abstract getWsRequestEvents(operation: WSOperation, requests: WsTopicRequest<string>[], wsKey: TWSKey): Promise<MidflightWsRequestEvent<TWSRequestEvent>[]>;
+    /**
+     * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
+     */
+    protected abstract resolveEmittableEvents(wsKey: TWSKey, event: MessageEventLike): EmittableEvent[];
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+     */
+    protected abstract connectAll(): Promise<WSConnectedResult | undefined>[];
+    protected isPrivateWsKey(wsKey: TWSKey): boolean;
+    /** Returns auto-incrementing request ID, used to track promise references for async requests */
+    protected getNewRequestId(): number;
+    protected abstract sendWSAPIRequest(wsKey: TWSKey, operation: string, category: string, params?: any): Promise<unknown>;
+    getTimeOffsetMs(): number;
+    setTimeOffsetMs(newOffset: number): void;
+    /**
+     * Don't call directly! Use subscribe() instead!
+     *
+     * Subscribe to one or more topics on a WS connection (identified by WS Key).
+     *
+     * - Topics are automatically cached
+     * - Connections are automatically opened, if not yet connected
+     * - Authentication is automatically handled
+     * - Topics are automatically resubscribed to, if something happens to the connection, unless you call unsubsribeTopicsForWsKey(topics, key).
+     *
+     * @param wsRequests array of topics to subscribe to
+     * @param wsKey ws key referring to the ws connection these topics should be subscribed on
+     */
+    protected subscribeTopicsForWsKey(wsTopicRequests: WsTopicRequestOrStringTopic<string>[], wsKey: TWSKey): Promise<unknown>;
+    protected unsubscribeTopicsForWsKey(wsTopicRequests: WsTopicRequestOrStringTopic<string>[], wsKey: TWSKey): Promise<unknown>;
+    /**
+     * Splits topic requests into two groups, public & private topic requests
+     */
+    private sortTopicRequestsIntoPublicPrivate;
+    /** Get the WsStore that tracks websockets & topics */
+    getWsStore(): WsStore<TWSKey, WsTopicRequest<string>>;
+    close(wsKey: TWSKey, force?: boolean): void;
+    closeAll(force?: boolean): void;
+    isConnected(wsKey: TWSKey): boolean;
+    /**
+     * Request connection to a specific websocket, instead of waiting for automatic connection.
+     */
+    connect(wsKey: TWSKey, customUrl?: string | undefined, throwOnError?: boolean): Promise<WSConnectedResult | undefined>;
+    private connectToWsUrl;
+    private parseWsError;
+    /** Get a signature, build the auth request and send it */
+    private sendAuthRequest;
+    private reconnectWithDelay;
+    private ping;
+    private clearTimers;
+    private clearPingTimer;
+    private clearPongTimer;
+    /**
+     * Returns a list of string events that can be individually sent upstream to complete subscribing/unsubscribing/etc to these topics
+     *
+     * If events are an object, these should be stringified (`return JSON.stringify(event);`)
+     * Each event returned by this will be sent one at a time
+     *
+     * Events are automatically split into smaller batches, by this method, if needed.
+     */
+    protected getWsOperationEventsForTopics(topics: WsTopicRequest<string>[], wsKey: TWSKey, operation: WSOperation): Promise<MidflightWsRequestEvent<TWSRequestEvent>[]>;
+    /**
+     * @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;
+    getCachedMidFlightRequest(wsKey: TWSKey, requestKey: string): TWSRequestEvent | undefined;
+    removeCachedMidFlightRequest(wsKey: TWSKey, requestKey: string): void;
+    tryWsSend(wsKey: TWSKey, wsMessage: string, throwExceptions?: boolean): void;
+    private onWsOpen;
+    /**
+     * Handle subscription to private topics _after_ authentication successfully completes asynchronously.
+     *
+     * Only used for exchanges that require auth before sending private topic subscription requests
+     */
+    private onWsAuthenticated;
+    /**
+     * Raw incoming event handler. Parsing happens in integration layer via resolveEmittableEvents().
+     */
+    private onWsMessage;
+    private onWsClose;
+    private getWs;
+    private setWsState;
+    /**
+     * Promise-driven method to assert that a ws has successfully connected (will await until connection is open)
+     */
+    assertIsConnected(wsKey: TWSKey): Promise<unknown>;
+    /**
+     * Promise-driven method to assert that a ws has been successfully authenticated (will await until auth is confirmed)
+     */
+    assertIsAuthenticated(wsKey: TWSKey): Promise<unknown>;
+}
+export {};