gateio-api 0.0.1 → 1.0.2

package/dist/mjs/lib/BaseRestClient.d.ts

@@ -0,0 +1,63 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestClientOptions } from './requestUtils.js';
+/**
+ * Used to switch how authentication/requests work under the hood
+ */
+export declare const REST_CLIENT_TYPE_ENUM: {
+    readonly main: "main";
+};
+export type RestClientType = (typeof REST_CLIENT_TYPE_ENUM)[keyof typeof REST_CLIENT_TYPE_ENUM];
+/**
+ * Some requests require some params to be in the query string and some in the body.
+ * This type anticipates both are possible in any combination.
+ *
+ * The request builder will automatically handle where parameters should go.
+ */
+type ParamsInQueryAndOrBody = {
+    query?: object;
+    body?: object;
+};
+export declare abstract class BaseRestClient {
+    private options;
+    private baseUrl;
+    private baseUrlPath;
+    private globalRequestOptions;
+    private apiKey;
+    private apiSecret;
+    /** 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(restClientOptions?: RestClientOptions, networkOptions?: AxiosRequestConfig);
+    /**
+     * Timestamp used to sign the request. Override this method to implement your own timestamp/sync mechanism
+     */
+    getSignTimestampMs(): number;
+    protected get(endpoint: string, params?: object): Promise<any>;
+    protected post(endpoint: string, params?: ParamsInQueryAndOrBody): Promise<any>;
+    protected getPrivate(endpoint: string, params?: object): Promise<any>;
+    protected postPrivate(endpoint: string, params?: ParamsInQueryAndOrBody): Promise<any>;
+    protected deletePrivate(endpoint: string, params?: ParamsInQueryAndOrBody): Promise<any>;
+    protected putPrivate(endpoint: string, params?: ParamsInQueryAndOrBody): Promise<any>;
+    protected patchPrivate(endpoint: string, params?: ParamsInQueryAndOrBody): Promise<any>;
+    /**
+     * @private Make a HTTP request to a specific endpoint. Private endpoint API calls are automatically signed.
+     */
+    private _call;
+    /**
+     * @private generic handler to parse request exceptions
+     */
+    parseException(e: any, request: AxiosRequestConfig<any>): unknown;
+    /**
+     * @private sign request and set recv window
+     */
+    private signRequest;
+    private signMessage;
+    private prepareSignParams;
+    /** Returns an axios request object. Handles signing process automatically if this is a private API call */
+    private buildRequest;
+}
+export {};

package/dist/mjs/lib/BaseRestClient.js

@@ -0,0 +1,317 @@
+import axios from 'axios';
+import { neverGuard } from './misc-util.js';
+import { CHANNEL_ID, getRestBaseUrl, serializeParams, } from './requestUtils.js';
+import { hashMessage, signMessage, } from './webCryptoAPI.js';
+const MISSING_API_KEYS_ERROR = 'API Key, Secret & Application ID are ALL required to use the authenticated REST client';
+/**
+ * Used to switch how authentication/requests work under the hood
+ */
+export const REST_CLIENT_TYPE_ENUM = {
+    main: 'main',
+};
+/**
+ * Enables:
+ * - Detailed request/response logging
+ * - Full request dump in any exceptions thrown from API responses
+ */
+const ENABLE_HTTP_TRACE = typeof process === 'object' &&
+    typeof process.env === 'object' &&
+    process.env.GATETRACE;
+if (ENABLE_HTTP_TRACE) {
+    axios.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.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;
+    });
+}
+/**
+ * Impure, mutates params to remove any values that have a key but are undefined.
+ */
+function deleteUndefinedValues(params) {
+    if (!params) {
+        return;
+    }
+    for (const key in params) {
+        const value = params[key];
+        if (typeof value === 'undefined') {
+            delete params[key];
+        }
+    }
+}
+export class BaseRestClient {
+    options;
+    baseUrl;
+    baseUrlPath;
+    globalRequestOptions;
+    apiKey;
+    apiSecret;
+    /**
+     * 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(restClientOptions = {}, networkOptions = {}) {
+        this.options = {
+            recvWindow: 5000,
+            /** Throw errors if any request params are empty */
+            strictParamValidation: false,
+            ...restClientOptions,
+        };
+        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: {
+                'Content-Type': 'application/json',
+                'X-Gate-Channel-Id': CHANNEL_ID,
+                locale: 'en-US',
+            },
+        };
+        this.baseUrl = getRestBaseUrl(restClientOptions);
+        this.baseUrlPath = new URL(this.baseUrl).pathname;
+        this.apiKey = this.options.apiKey;
+        this.apiSecret = this.options.apiSecret;
+        // Throw if one of the 3 values is missing, but at least one of them is set
+        const credentials = [this.apiKey, this.apiSecret];
+        if (credentials.includes(undefined) &&
+            credentials.some((v) => typeof v === 'string')) {
+            throw new Error(MISSING_API_KEYS_ERROR);
+        }
+    }
+    /**
+     * Timestamp used to sign the request. Override this method to implement your own timestamp/sync mechanism
+     */
+    getSignTimestampMs() {
+        return Date.now();
+    }
+    get(endpoint, params) {
+        const isPublicAPI = true;
+        // GET only supports params in the query string
+        return this._call('GET', endpoint, { query: params }, isPublicAPI);
+    }
+    post(endpoint, params) {
+        const isPublicAPI = true;
+        return this._call('POST', endpoint, params, isPublicAPI);
+    }
+    getPrivate(endpoint, params) {
+        const isPublicAPI = false;
+        // GET only supports params in the query string
+        return this._call('GET', endpoint, { query: params }, isPublicAPI);
+    }
+    postPrivate(endpoint, params) {
+        const isPublicAPI = false;
+        return this._call('POST', endpoint, params, isPublicAPI);
+    }
+    deletePrivate(endpoint, params) {
+        const isPublicAPI = false;
+        return this._call('DELETE', endpoint, params, isPublicAPI);
+    }
+    putPrivate(endpoint, params) {
+        const isPublicAPI = false;
+        return this._call('PUT', endpoint, params, isPublicAPI);
+    }
+    // protected patchPrivate(endpoint: string, params?: any) {
+    patchPrivate(endpoint, params) {
+        const isPublicAPI = false;
+        return this._call('PATCH', endpoint, params, isPublicAPI);
+    }
+    /**
+     * @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 axios(options)
+            .then((response) => {
+            if (response.status == 200 || response.status == 201) {
+                // Throw API rejections by parsing the response code from the body
+                if (typeof response.data?.code === 'number' &&
+                    response.data?.code !== 1000) {
+                    throw { response };
+                }
+                return response.data;
+            }
+            throw { response };
+        })
+            .catch((e) => this.parseException(e, options));
+    }
+    /**
+     * @private generic handler to parse request exceptions
+     */
+    parseException(e, request) {
+        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);
+        const debugData = ENABLE_HTTP_TRACE ? { fullRequest: request } : {};
+        throw {
+            code: response.status,
+            message: response.statusText,
+            body: response.data,
+            headers: response.headers,
+            requestOptions: {
+                ...this.options,
+                // Prevent credentials from leaking into error messages
+                apiKey: 'omittedFromError',
+                apiMemo: 'omittedFromError',
+                apiSecret: 'omittedFromError',
+                reqUrl: request.url,
+                reqBody: request.data,
+            },
+            ...debugData,
+        };
+    }
+    /**
+     * @private sign request and set recv window
+     */
+    async signRequest(data, endpoint, method, signMethod) {
+        const timestamp = +(this.getSignTimestampMs() / 1000).toFixed(0); // in seconds
+        const res = {
+            originalParams: {
+                // recvWindow: this.options.recvWindow,
+                ...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 = true;
+        if (signMethod === 'gateV4') {
+            const signEncoding = 'hex';
+            const signAlgoritm = 'SHA-512';
+            const queryStringToSign = data?.query
+                ? serializeParams(res.originalParams?.query, strictParamValidation, encodeQueryStringValues, '')
+                : '';
+            const requestBodyToHash = res.originalParams?.body
+                ? JSON.stringify(res.originalParams?.body)
+                : '';
+            const hashedRequestBody = await hashMessage(requestBodyToHash, signEncoding, signAlgoritm);
+            const toSign = [
+                method,
+                this.baseUrlPath + endpoint,
+                queryStringToSign,
+                hashedRequestBody,
+                timestamp,
+            ].join('\n');
+            // console.log('sign params: ', {
+            //   requestBodyToHash,
+            //   paramsStr: toSign,
+            //   url: this.baseUrl,
+            //   urlPath: this.baseUrlPath,
+            // });
+            res.sign = await this.signMessage(toSign, this.apiSecret, signEncoding, signAlgoritm);
+            res.queryParamsWithSign = queryStringToSign;
+            return res;
+        }
+        console.error(new Date(), neverGuard(signMethod, `Unhandled sign method: "${signMessage}"`));
+        return res;
+    }
+    async signMessage(paramsStr, secret, method, algorithm) {
+        if (typeof this.options.customSignMessageFn === 'function') {
+            return this.options.customSignMessageFn(paramsStr, secret);
+        }
+        return await signMessage(paramsStr, secret, method, algorithm);
+    }
+    async prepareSignParams(method, endpoint, signMethod, params, isPublicApi) {
+        if (isPublicApi) {
+            return {
+                originalParams: params,
+                paramsWithSign: params,
+            };
+        }
+        if (!this.apiKey || !this.apiSecret) {
+            throw new Error(MISSING_API_KEYS_ERROR);
+        }
+        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,
+        };
+        deleteUndefinedValues(params);
+        deleteUndefinedValues(params?.body);
+        deleteUndefinedValues(params?.query);
+        if (isPublicApi || !this.apiKey || !this.apiSecret) {
+            return {
+                ...options,
+                params: params?.query || params?.body || params,
+            };
+        }
+        const signResult = await this.prepareSignParams(method, endpoint, 'gateV4', params, isPublicApi);
+        const authHeaders = {
+            KEY: this.apiKey,
+            SIGN: signResult.sign,
+            Timestamp: signResult.timestamp,
+        };
+        const urlWithQueryParams = options.url + '?' + signResult.queryParamsWithSign;
+        if (method === 'GET' || !params?.body) {
+            return {
+                ...options,
+                headers: {
+                    ...authHeaders,
+                    ...options.headers,
+                },
+                url: urlWithQueryParams,
+            };
+        }
+        return {
+            ...options,
+            headers: {
+                ...authHeaders,
+                ...options.headers,
+            },
+            url: params?.query ? urlWithQueryParams : options.url,
+            data: signResult.originalParams.body,
+        };
+    }
+}
+//# sourceMappingURL=BaseRestClient.js.map

package/dist/mjs/lib/BaseRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../../src/lib/BaseRestClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAoD,MAAM,OAAO,CAAC;AAEzE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EACL,UAAU,EACV,cAAc,EAEd,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,WAAW,EAGX,WAAW,GACZ,MAAM,mBAAmB,CAAC;AAE3B,MAAM,sBAAsB,GAC1B,wFAAwF,CAAC;AAE3F;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM;CACJ,CAAC;AA8BX;;;;GAIG;AACH,MAAM,iBAAiB,GACrB,OAAO,OAAO,KAAK,QAAQ;IAC3B,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ;IAC/B,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;AAExB,IAAI,iBAAiB,EAAE,CAAC;IACtB,KAAK,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,KAAK,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;;GAEG;AACH,SAAS,qBAAqB,CAAC,MAAY;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,OAAgB,cAAc;IAC1B,OAAO,CAAoB;IAC3B,OAAO,CAAS;IAChB,WAAW,CAAS;IACpB,oBAAoB,CAAqB;IACzC,MAAM,CAAqB;IAC3B,SAAS,CAAqB;IAKtC;;;;OAIG;IACH,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,IAAI,CAAC,OAAO,GAAG;YACb,UAAU,EAAE,IAAI;YAChB,mDAAmD;YACnD,qBAAqB,EAAE,KAAK;YAC5B,GAAG,iBAAiB;SACrB,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,cAAc,EAAE,kBAAkB;gBAClC,mBAAmB,EAAE,UAAU;gBAC/B,MAAM,EAAE,OAAO;aAChB;SACF,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC;QAElD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAExC,2EAA2E;QAC3E,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAClD,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,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC;IAES,GAAG,CAAC,QAAgB,EAAE,MAAe;QAC7C,MAAM,WAAW,GAAG,IAAI,CAAC;QACzB,+CAA+C;QAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC;IACrE,CAAC;IAES,IAAI,CAAC,QAAgB,EAAE,MAA+B;QAC9D,MAAM,WAAW,GAAG,IAAI,CAAC;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAES,UAAU,CAAC,QAAgB,EAAE,MAAe;QACpD,MAAM,WAAW,GAAG,KAAK,CAAC;QAC1B,+CAA+C;QAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC;IACrE,CAAC;IAES,WAAW,CAAC,QAAgB,EAAE,MAA+B;QACrE,MAAM,WAAW,GAAG,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3D,CAAC;IAES,aAAa,CAAC,QAAgB,EAAE,MAA+B;QACvE,MAAM,WAAW,GAAG,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC;IAES,UAAU,CAAC,QAAgB,EAAE,MAA+B;QACpE,MAAM,WAAW,GAAG,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1D,CAAC;IAED,2DAA2D;IACjD,YAAY,CAAC,QAAgB,EAAE,MAA+B;QACtE,MAAM,WAAW,GAAG,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAA+B,EAC/B,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,KAAK,CAAC,OAAO,CAAC;aAClB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;gBACrD,kEAAkE;gBAClE,IACE,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,QAAQ;oBACvC,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,EAC5B,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,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,CAAM,EAAE,OAAgC;QACrD,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,SAAS,GAAG,iBAAiB,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEpE,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,MAAM,EAAE,kBAAkB;gBAC1B,OAAO,EAAE,kBAAkB;gBAC3B,SAAS,EAAE,kBAAkB;gBAC7B,MAAM,EAAE,OAAO,CAAC,GAAG;gBACnB,OAAO,EAAE,OAAO,CAAC,IAAI;aACtB;YACD,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,WAAW,CACvB,IAAO,EACP,QAAgB,EAChB,MAAc,EACd,UAAsB;QAEtB,MAAM,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa;QAE/E,MAAM,GAAG,GAAqB;YAC5B,cAAc,EAAE;gBACd,uCAAuC;gBACvC,GAAG,IAAI;aACR;YAED,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;QAErC,IAAI,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,YAAY,GAAqB,KAAK,CAAC;YAC7C,MAAM,YAAY,GAAkB,SAAS,CAAC;YAE9C,MAAM,iBAAiB,GAAG,IAAI,EAAE,KAAK;gBACnC,CAAC,CAAC,eAAe,CACb,GAAG,CAAC,cAAc,EAAE,KAAK,EACzB,qBAAqB,EACrB,uBAAuB,EACvB,EAAE,CACH;gBACH,CAAC,CAAC,EAAE,CAAC;YAEP,MAAM,iBAAiB,GAAG,GAAG,CAAC,cAAc,EAAE,IAAI;gBAChD,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC;gBAC1C,CAAC,CAAC,EAAE,CAAC;YAEP,MAAM,iBAAiB,GAAG,MAAM,WAAW,CACzC,iBAAiB,EACjB,YAAY,EACZ,YAAY,CACb,CAAC;YAEF,MAAM,MAAM,GAAG;gBACb,MAAM;gBACN,IAAI,CAAC,WAAW,GAAG,QAAQ;gBAC3B,iBAAiB;gBACjB,iBAAiB;gBACjB,SAAS;aACV,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEb,iCAAiC;YACjC,uBAAuB;YACvB,uBAAuB;YACvB,uBAAuB;YACvB,+BAA+B;YAC/B,MAAM;YAEN,GAAG,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAC/B,MAAM,EACN,IAAI,CAAC,SAAS,EACd,YAAY,EACZ,YAAY,CACb,CAAC;YACF,GAAG,CAAC,mBAAmB,GAAG,iBAAiB,CAAC;YAC5C,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,CAAC,KAAK,CACX,IAAI,IAAI,EAAE,EACV,UAAU,CAAC,UAAU,EAAE,2BAA2B,WAAW,GAAG,CAAC,CAClE,CAAC;QAEF,OAAO,GAAG,CAAC;IACb,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,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAoBO,KAAK,CAAC,iBAAiB,CAG7B,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,sBAAsB,CAAC,CAAC;QAC1C,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,MAA+B,EAC/B,WAAqB;QAErB,MAAM,OAAO,GAAuB;YAClC,GAAG,IAAI,CAAC,oBAAoB;YAC5B,GAAG,EAAE,GAAG;YACR,MAAM,EAAE,MAAM;SACf,CAAC;QAEF,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC9B,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpC,qBAAqB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAErC,IAAI,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACnD,OAAO;gBACL,GAAG,OAAO;gBACV,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,MAAM,EAAE,IAAI,IAAI,MAAM;aAChD,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,GAAG,EAAE,IAAI,CAAC,MAAM;YAChB,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,SAAS,EAAE,UAAU,CAAC,SAAS;SAChC,CAAC;QAEF,MAAM,kBAAkB,GACtB,OAAO,CAAC,GAAG,GAAG,GAAG,GAAG,UAAU,CAAC,mBAAmB,CAAC;QAErD,IAAI,MAAM,KAAK,KAAK,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;YACtC,OAAO;gBACL,GAAG,OAAO;gBACV,OAAO,EAAE;oBACP,GAAG,WAAW;oBACd,GAAG,OAAO,CAAC,OAAO;iBACnB;gBACD,GAAG,EAAE,kBAAkB;aACxB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,WAAW;gBACd,GAAG,OAAO,CAAC,OAAO;aACnB;YACD,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG;YACrD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,IAAI;SACrC,CAAC;IACJ,CAAC;CACF"}

package/dist/mjs/lib/BaseWSClient.d.ts

@@ -0,0 +1,172 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+import WebSocket from 'isomorphic-ws';
+import { WebsocketClientOptions, WSClientConfigurableOptions } from '../types/websockets/client.js';
+import { WsOperation } from '../types/websockets/requests.js';
+import { DefaultLogger } from './logger.js';
+import { MessageEventLike } from './requestUtils.js';
+import { WsTopicRequest, WsTopicRequestOrStringTopic } from './websocket/websocket-util.js';
+import { WsStore } from './websocket/WsStore.js';
+import { DeferredPromise } from './websocket/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;
+    }) => 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;
+    error: (response: any & {
+        wsKey: WsKey;
+    }) => void;
+    /** Confirmation that a connection successfully authenticated */
+    authenticated: (event: {
+        wsKey: WsKey;
+        event: any;
+    }) => void;
+}
+export interface EmittableEvent<TEvent = any> {
+    eventType: 'response' | 'update' | 'exception' | 'authenticated';
+    event: TEvent;
+}
+export interface BaseWebsocketClient<TWSKey extends string> {
+    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;
+}
+/**
+ * Base WebSocket abstraction layer. Handles connections, tracking each connection as a unique "WS Key"
+ */
+export declare abstract class BaseWebsocketClient<
+/**
+ * The WS connections supported by the client, each identified by a unique primary key
+ */
+TWSKey extends string> extends EventEmitter {
+    /**
+     * State store to track a list of topics (topic requests) we are expected to be subscribed to if reconnected
+     */
+    private wsStore;
+    protected logger: typeof DefaultLogger;
+    protected options: WebsocketClientOptions;
+    private wsApiRequestId;
+    constructor(options?: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
+    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): string;
+    protected abstract getMaxTopicsPerSubscribeEvent(wsKey: TWSKey): number | null;
+    /**
+     * Returns a list of string events that can be individually sent upstream to complete subscribing/unsubscribing/etc to these topics
+     */
+    protected abstract getWsOperationEventsForTopics(topics: WsTopicRequest<string>[], wsKey: TWSKey, operation: WsOperation): Promise<string[]>;
+    /**
+     * 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(): (DeferredPromise['promise'] | undefined)[];
+    protected isPrivateWsKey(wsKey: TWSKey): boolean;
+    /** Returns auto-incrementing request ID, used to track promise references for async requests */
+    protected getNewRequestId(): string;
+    protected abstract sendWSAPIRequest(wsKey: TWSKey, channel: string, params?: any): Promise<unknown>;
+    protected abstract sendWSAPIRequest(wsKey: TWSKey, channel: string, params: any): Promise<unknown>;
+    /**
+     * 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): false | Promise<Promise<any> | undefined> | undefined;
+    protected unsubscribeTopicsForWsKey(wsTopicRequests: WsTopicRequestOrStringTopic<string>[], wsKey: TWSKey): void;
+    /**
+     * 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.
+     */
+    protected connect(wsKey: TWSKey): Promise<DeferredPromise['promise'] | 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;
+    /**
+     * Simply builds and sends subscribe events for a list of topics for a ws key
+     *
+     * @private Use the `subscribe(topics)` or `subscribeTopicsForWsKey(topics, wsKey)` method to subscribe to topics. Send WS message to subscribe to topics.
+     */
+    private requestSubscribeTopics;
+    /**
+     * Simply builds and sends unsubscribe events for a list of topics for a ws key
+     *
+     * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
+     */
+    private requestUnsubscribeTopics;
+    /**
+     * Try sending a string event on a WS connection (identified by the WS Key)
+     */
+    tryWsSend(wsKey: TWSKey, wsMessage: string): 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;
+    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)
+     */
+    protected assertIsConnected(wsKey: TWSKey): Promise<unknown>;
+}
+export {};