okx-api 2.0.7 → 3.0.0-beta.0

package/dist/cjs/util/websocket-util.js

@@ -0,0 +1,533 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_EVENT_CODE_ENUM = exports.PUBLIC_WS_KEYS = exports.PRIVATE_WS_KEYS = exports.WS_KEY_MAP = exports.WS_BASE_URL_MAP = exports.WS_LOGGER_CATEGORY = void 0;
+exports.getDemoWsKey = getDemoWsKey;
+exports.getWsKeyForTopicChannel = getWsKeyForTopicChannel;
+exports.getWsKeyForMarket = getWsKeyForMarket;
+exports.requiresWSAPITag = requiresWSAPITag;
+exports.validateWSAPITag = validateWSAPITag;
+exports.getWsUrlForWsKey = getWsUrlForWsKey;
+exports.getMaxTopicsPerSubscribeEventForMarket = getMaxTopicsPerSubscribeEventForMarket;
+exports.isWsPong = isWsPong;
+exports.safeTerminateWs = safeTerminateWs;
+exports.getNormalisedTopicRequests = getNormalisedTopicRequests;
+exports.isWSPingFrameAvailable = isWSPingFrameAvailable;
+exports.isWSPongFrameAvailable = isWSPongFrameAvailable;
+exports.getPromiseRefForWSAPIRequest = getPromiseRefForWSAPIRequest;
+const ws_api_js_1 = require("../types/websockets/ws-api.js");
+const requestUtils_js_1 = require("./requestUtils.js");
+const typeGuards_js_1 = require("./typeGuards.js");
+exports.WS_LOGGER_CATEGORY = { category: 'okx-ws' };
+exports.WS_BASE_URL_MAP = {
+    prod: {
+        live: {
+            public: 'wss://ws.okx.com:8443/ws/v5/public',
+            private: 'wss://ws.okx.com:8443/ws/v5/private',
+            // Some channels require business suffix: https://www.okx.com/help/changes-to-v5-api-websocket-subscription-parameter-and-url
+            business: 'wss://ws.okx.com:8443/ws/v5/business',
+        },
+        demo: {
+            public: 'wss://wspap.okx.com:8443/ws/v5/public',
+            private: 'wss://wspap.okx.com:8443/ws/v5/private',
+            business: 'wss://wspap.okx.com:8443/ws/v5/business?brokerId=9999',
+        },
+    },
+    // Exactly the same as "prod"
+    // also known as "www.okx.com", the default: https://www.okx.com/docs-v5/en/#overview-production-trading-services
+    GLOBAL: {
+        live: {
+            public: 'wss://ws.okx.com:8443/ws/v5/public',
+            private: 'wss://ws.okx.com:8443/ws/v5/private',
+            // Some channels require business suffix: https://www.okx.com/help/changes-to-v5-api-websocket-subscription-parameter-and-url
+            business: 'wss://ws.okx.com:8443/ws/v5/business',
+        },
+        demo: {
+            public: 'wss://wspap.okx.com:8443/ws/v5/public',
+            private: 'wss://wspap.okx.com:8443/ws/v5/private',
+            business: 'wss://wspap.okx.com:8443/ws/v5/business?brokerId=9999',
+        },
+    },
+    // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
+    EEA: {
+        live: {
+            public: 'wss://wseea.okx.com:8443/ws/v5/public',
+            private: 'wss://wseea.okx.com:8443/ws/v5/private',
+            // Some channels require business suffix: https://www.okx.com/help/changes-to-v5-api-websocket-subscription-parameter-and-url
+            business: 'wss://wseea.okx.com:8443/ws/v5/business',
+        },
+        demo: {
+            public: 'wss://wseeapap.okx.com:8443/ws/v5/public',
+            private: 'wss://wseeapap.okx.com:8443/ws/v5/private',
+            business: 'wss://wseeapap.okx.com:8443/ws/v5/business?brokerId=9999',
+        },
+    },
+    // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
+    US: {
+        live: {
+            public: 'wss://wsus.okx.com:8443/ws/v5/public',
+            private: 'wss://wsus.okx.com:8443/ws/v5/private',
+            // Some channels require business suffix: https://www.okx.com/help/changes-to-v5-api-websocket-subscription-parameter-and-url
+            business: 'wss://wsus.okx.com:8443/ws/v5/business',
+        },
+        demo: {
+            public: 'wss://wsuspap.okx.com:8443/ws/v5/public',
+            private: 'wss://wsuspap.okx.com:8443/ws/v5/private',
+            business: 'wss://wsuspap.okx.com:8443/ws/v5/business?brokerId=9999',
+        },
+    },
+};
+exports.WS_KEY_MAP = {
+    // OKX Global: https://www.okx.com/docs-v5/en/#overview-production-trading-services
+    /**
+     * Public WS connection for OKX Global (www.okx.com), does not require auth.
+     */
+    prodPublic: 'prodPublic',
+    /**
+     * Private WS connection for OKX Global (www.okx.com), requires auth.
+     */
+    prodPrivate: 'prodPrivate',
+    /**
+     * Business WS connection for OKX Global (www.okx.com), sometimes requires auth.
+     */
+    prodBusiness: 'prodBusiness',
+    /**
+     * Public DEMO WS connection for OKX Global (www.okx.com), does not require auth.
+     */
+    prodDemoPublic: 'prodDemoPublic',
+    /**
+     * Private DEMO WS connection for OKX Global (www.okx.com), requires auth.
+     */
+    prodDemoPrivate: 'prodDemoPrivate',
+    /**
+     * Business DEMO WS connection for OKX Global (www.okx.com), sometimes requires auth.
+     */
+    prodDemoBusiness: 'prodDemoBusiness',
+    // Also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
+    /**
+     * Public WS connection for OKX EEA (my.okx.com), does not require auth.
+     */
+    eeaLivePublic: 'eeaLivePublic',
+    /**
+     * Private WS connection for OKX EEA (my.okx.com), requires auth.
+     */
+    eeaLivePrivate: 'eeaLivePrivate',
+    /**
+     * Business WS connection for OKX EEA (my.okx.com), sometimes requires auth.
+     */
+    eeaLiveBusiness: 'eeaLiveBusiness',
+    /**
+     * Public DEMO WS connection for OKX EEA (my.okx.com), does not require auth.
+     */
+    eeaDemoPublic: 'eeaDemoPublic',
+    /**
+     * Private DEMO WS connection for OKX EEA (my.okx.com), requires auth.
+     */
+    eeaDemoPrivate: 'eeaDemoPrivate',
+    /**
+     * Business DEMO WS connection for OKX EEA (my.okx.com), sometimes requires auth.
+     */
+    eeaDemoBusiness: 'eeaDemoBusiness',
+    // Also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
+    /**
+     * Public WS connection for OKX US (app.okx.com), does not require auth.
+     */
+    usLivePublic: 'usLivePublic',
+    /**
+     * Private WS connection for OKX US (app.okx.com), requires auth.
+     */
+    usLivePrivate: 'usLivePrivate',
+    /**
+     * Business WS connection for OKX US (app.okx.com), sometimes requires auth.
+     */
+    usLiveBusiness: 'usLiveBusiness',
+    usDemoPublic: 'usDemoPublic',
+    usDemoPrivate: 'usDemoPrivate',
+    usDemoBusiness: 'usDemoBusiness',
+};
+exports.PRIVATE_WS_KEYS = [
+    exports.WS_KEY_MAP.prodPrivate,
+    exports.WS_KEY_MAP.prodBusiness,
+    exports.WS_KEY_MAP.prodDemoPrivate,
+    exports.WS_KEY_MAP.prodDemoBusiness,
+    exports.WS_KEY_MAP.eeaLivePrivate,
+    exports.WS_KEY_MAP.eeaLiveBusiness,
+    exports.WS_KEY_MAP.eeaDemoPrivate,
+    exports.WS_KEY_MAP.eeaDemoBusiness,
+    exports.WS_KEY_MAP.usLivePrivate,
+    exports.WS_KEY_MAP.usLiveBusiness,
+    exports.WS_KEY_MAP.usDemoPrivate,
+    exports.WS_KEY_MAP.usDemoBusiness,
+];
+exports.PUBLIC_WS_KEYS = [
+    exports.WS_KEY_MAP.prodPublic,
+    exports.WS_KEY_MAP.prodDemoPublic,
+    exports.WS_KEY_MAP.eeaLivePublic,
+    exports.WS_KEY_MAP.eeaDemoPublic,
+    exports.WS_KEY_MAP.usLivePublic,
+    exports.WS_KEY_MAP.usDemoPublic,
+];
+/**
+ * Returns the DEMO connection WsKey for the provided WsKey
+ */
+function getDemoWsKey(wsKey) {
+    switch (wsKey) {
+        case exports.WS_KEY_MAP.prodDemoPublic:
+        case exports.WS_KEY_MAP.prodDemoPrivate:
+        case exports.WS_KEY_MAP.prodDemoBusiness:
+        case exports.WS_KEY_MAP.eeaDemoPublic:
+        case exports.WS_KEY_MAP.eeaDemoPrivate:
+        case exports.WS_KEY_MAP.eeaDemoBusiness:
+        case exports.WS_KEY_MAP.usDemoPublic:
+        case exports.WS_KEY_MAP.usDemoPrivate:
+        case exports.WS_KEY_MAP.usDemoBusiness: {
+            return wsKey;
+        }
+        case exports.WS_KEY_MAP.prodPublic:
+            return exports.WS_KEY_MAP.prodDemoPublic;
+        case exports.WS_KEY_MAP.prodPrivate:
+            return exports.WS_KEY_MAP.prodDemoBusiness;
+        case exports.WS_KEY_MAP.prodBusiness:
+            return exports.WS_KEY_MAP.prodDemoBusiness;
+        case exports.WS_KEY_MAP.eeaLivePublic:
+            return exports.WS_KEY_MAP.eeaDemoPublic;
+        case exports.WS_KEY_MAP.eeaLivePrivate:
+            return exports.WS_KEY_MAP.eeaDemoPrivate;
+        case exports.WS_KEY_MAP.eeaLiveBusiness:
+            return exports.WS_KEY_MAP.eeaDemoBusiness;
+        case exports.WS_KEY_MAP.usLivePublic:
+            return exports.WS_KEY_MAP.usDemoPublic;
+        case exports.WS_KEY_MAP.usLivePrivate:
+            return exports.WS_KEY_MAP.usDemoPrivate;
+        case exports.WS_KEY_MAP.usLiveBusiness:
+            return exports.WS_KEY_MAP.usDemoBusiness;
+        default:
+            throw (0, typeGuards_js_1.neverGuard)(wsKey, `Unhandled wsKey "${wsKey}"`);
+    }
+}
+/** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
+const PRIVATE_CHANNELS = [
+    'account',
+    'positions',
+    'balance_and_position',
+    'orders',
+    'orders-algo',
+    'algo-advance',
+    'liquidation-warning',
+    'account-greeks',
+    'grid-orders-spot',
+    'grid-orders-contract',
+    'grid-orders-moon',
+    'grid-positions',
+    'grid-sub-orders',
+];
+/**
+ * The following channels only support the new business wss endpoint:
+ * https://www.okx.com/help-center/changes-to-v5-api-websocket-subscription-parameter-and-url
+ */
+const BUSINESS_CHANNELS = [
+    'orders-algo',
+    'algo-advance',
+    'deposit-info',
+    'withdrawal-info',
+    'grid-orders-spot',
+    'grid-orders-contract',
+    'grid-orders-moon',
+    'grid-positions',
+    'grid-sub-orders',
+    'algo-recurring-buy',
+    'candle1Y',
+    'candle6M',
+    'candle3M',
+    'candle1M',
+    'candle1W',
+    'candle1D',
+    'candle2D',
+    'candle3D',
+    'candle5D',
+    'candle12H',
+    'candle6H',
+    'candle4H',
+    'candle2H',
+    'candle1H',
+    'candle30m',
+    'candle15m',
+    'candle5m',
+    'candle3m',
+    'candle1m',
+    'candle1s',
+    'candle1Yutc',
+    'candle3Mutc',
+    'candle1Mutc',
+    'candle1Wutc',
+    'candle1Dutc',
+    'candle2Dutc',
+    'candle3Dutc',
+    'candle5Dutc',
+    'candle12Hutc',
+    'candle6Hutc',
+    'mark-price-candle1Y',
+    'mark-price-candle6M',
+    'mark-price-candle3M',
+    'mark-price-candle1M',
+    'mark-price-candle1W',
+    'mark-price-candle1D',
+    'mark-price-candle2D',
+    'mark-price-candle3D',
+    'mark-price-candle5D',
+    'mark-price-candle12H',
+    'mark-price-candle6H',
+    'mark-price-candle4H',
+    'mark-price-candle2H',
+    'mark-price-candle1H',
+    'mark-price-candle30m',
+    'mark-price-candle15m',
+    'mark-price-candle5m',
+    'mark-price-candle3m',
+    'mark-price-candle1m',
+    'mark-price-candle1Yutc',
+    'mark-price-candle3Mutc',
+    'mark-price-candle1Mutc',
+    'mark-price-candle1Wutc',
+    'mark-price-candle1Dutc',
+    'mark-price-candle2Dutc',
+    'mark-price-candle3Dutc',
+    'mark-price-candle5Dutc',
+    'mark-price-candle12Hutc',
+    'mark-price-candle6Hutc',
+    'index-candle1Y',
+    'index-candle6M',
+    'index-candle3M',
+    'index-candle1M',
+    'index-candle1W',
+    'index-candle1D',
+    'index-candle2D',
+    'index-candle3D',
+    'index-candle5D',
+    'index-candle12H',
+    'index-candle6H',
+    'index-candle4H index -candle2H',
+    'index-candle1H',
+    'index-candle30m',
+    'index-candle15m',
+    'index-candle5m',
+    'index-candle3m',
+    'index-candle1m',
+    'index-candle1Yutc',
+    'index-candle3Mutc',
+    'index-candle1Mutc',
+    'index-candle1Wutc',
+    'index-candle1Dutc',
+    'index-candle2Dutc',
+    'index-candle3Dutc',
+    'index-candle5Dutc',
+    'index-candle12Hutc',
+    'index-candle6Hutc',
+];
+/** Determine which WsKey (ws connection) to route an event to */
+function getWsKeyForTopicChannel(market, channel, isPrivate) {
+    const isPrivateTopic = isPrivate === true || PRIVATE_CHANNELS.includes(channel);
+    const isBusinessChannel = BUSINESS_CHANNELS.includes(channel);
+    return getWsKeyForMarket(market, isPrivateTopic, isBusinessChannel);
+}
+/**
+ * Returns wsKey for product group. Demo resolution is handled in URL lookup function, separately.
+ */
+function getWsKeyForMarket(market, isPrivate, isBusinessChannel) {
+    switch (market) {
+        case 'prod':
+        case 'GLOBAL': {
+            if (isBusinessChannel) {
+                return exports.WS_KEY_MAP.prodBusiness;
+            }
+            return isPrivate ? exports.WS_KEY_MAP.prodPrivate : exports.WS_KEY_MAP.prodPublic;
+        }
+        case 'EEA': {
+            if (isBusinessChannel) {
+                return exports.WS_KEY_MAP.eeaLiveBusiness;
+            }
+            return isPrivate ? exports.WS_KEY_MAP.eeaLivePrivate : exports.WS_KEY_MAP.eeaLivePublic;
+        }
+        case 'US': {
+            if (isBusinessChannel) {
+                return exports.WS_KEY_MAP.usLiveBusiness;
+            }
+            return isPrivate ? exports.WS_KEY_MAP.usLivePrivate : exports.WS_KEY_MAP.usLivePublic;
+        }
+        default: {
+            throw (0, typeGuards_js_1.neverGuard)(market, `getWsKeyForTopic(): Unhandled market "${market}"`);
+        }
+    }
+}
+function requiresWSAPITag(operation, wsKey) {
+    switch (wsKey) {
+        case exports.WS_KEY_MAP.prodPublic:
+        case exports.WS_KEY_MAP.prodDemoPublic:
+        case exports.WS_KEY_MAP.eeaLivePublic:
+        case exports.WS_KEY_MAP.eeaDemoPublic:
+        case exports.WS_KEY_MAP.usLivePublic:
+        case exports.WS_KEY_MAP.usDemoPublic:
+            return false;
+        case exports.WS_KEY_MAP.prodDemoPrivate:
+        case exports.WS_KEY_MAP.prodDemoBusiness:
+        case exports.WS_KEY_MAP.eeaDemoPrivate:
+        case exports.WS_KEY_MAP.eeaDemoBusiness:
+        case exports.WS_KEY_MAP.usDemoPrivate:
+        case exports.WS_KEY_MAP.usDemoBusiness:
+        case exports.WS_KEY_MAP.prodPrivate:
+        case exports.WS_KEY_MAP.prodBusiness:
+        case exports.WS_KEY_MAP.eeaLivePrivate:
+        case exports.WS_KEY_MAP.eeaLiveBusiness:
+        case exports.WS_KEY_MAP.usLivePrivate:
+        case exports.WS_KEY_MAP.usLiveBusiness:
+            return ws_api_js_1.WS_API_TAG_OPERATIONS.includes(operation);
+        default: {
+            throw (0, typeGuards_js_1.neverGuard)(wsKey, `Unhandled WsKey "${wsKey}"`);
+        }
+    }
+}
+function validateWSAPITag(request, wsKey) {
+    if (!requiresWSAPITag(request.op, wsKey)) {
+        return;
+    }
+    for (let i = 0; i < request.args.length; i++) {
+        request.args[i]['tag'] = requestUtils_js_1.programId;
+    }
+}
+/**
+ * Maps a WS key back to a WS URL. Resolves to demo wsKey automatically, if configured.
+ */
+function getWsUrlForWsKey(wsKey, wsClientOptions, logger) {
+    if (wsClientOptions.wsUrl) {
+        return wsClientOptions.wsUrl;
+    }
+    const isDemoTrading = !!wsClientOptions?.demoTrading;
+    const LIVE_OR_DEMO = isDemoTrading ? 'demo' : 'live';
+    switch (wsKey) {
+        // Global (www.okx.com)
+        case 'prodPublic':
+        case 'prodDemoPublic':
+            return exports.WS_BASE_URL_MAP.GLOBAL[LIVE_OR_DEMO].public;
+        case 'prodPrivate':
+        case 'prodDemoPrivate':
+            return exports.WS_BASE_URL_MAP.GLOBAL[LIVE_OR_DEMO].private;
+        case 'prodBusiness':
+        case 'prodDemoBusiness':
+            return exports.WS_BASE_URL_MAP.GLOBAL[LIVE_OR_DEMO].business;
+        // EEA (my.okx.com)
+        case 'eeaLivePublic':
+        case 'eeaDemoPublic':
+            return exports.WS_BASE_URL_MAP.EEA[LIVE_OR_DEMO].public;
+        case 'eeaLivePrivate':
+        case 'eeaDemoPrivate':
+            return exports.WS_BASE_URL_MAP.EEA[LIVE_OR_DEMO].private;
+        case 'eeaLiveBusiness':
+        case 'eeaDemoBusiness':
+            return exports.WS_BASE_URL_MAP.EEA[LIVE_OR_DEMO].business;
+        // US (app.okx.com)
+        case 'usLivePublic':
+        case 'usDemoPublic':
+            return exports.WS_BASE_URL_MAP.US[LIVE_OR_DEMO].public;
+        case 'usLivePrivate':
+        case 'usDemoPrivate':
+            return exports.WS_BASE_URL_MAP.US[LIVE_OR_DEMO].private;
+        case 'usLiveBusiness':
+        case 'usDemoBusiness':
+            return exports.WS_BASE_URL_MAP.US[LIVE_OR_DEMO].business;
+        default: {
+            const errorMessage = 'getWsUrl(): Unhandled wsKey: ';
+            logger.error(errorMessage, {
+                category: 'okx-ws',
+                wsKey,
+            });
+            throw (0, typeGuards_js_1.neverGuard)(wsKey, errorMessage);
+        }
+    }
+}
+function getMaxTopicsPerSubscribeEventForMarket(market) {
+    switch (market) {
+        case 'prod':
+        case 'EEA':
+        case 'GLOBAL':
+        case 'US': {
+            return null;
+        }
+        default: {
+            throw (0, typeGuards_js_1.neverGuard)(market, 'getWsKeyForTopic(): Unhandled market');
+        }
+    }
+}
+function isWsPong(event) {
+    return (typeof event === 'object' &&
+        !!event &&
+        'data' in event &&
+        typeof event['data'] === 'string' &&
+        event['data'] === 'pong');
+}
+exports.WS_EVENT_CODE_ENUM = {
+    OK: '0',
+    LOGIN_FAILED: '60009',
+    LOGIN_PARTIALLY_FAILED: '60022',
+};
+/**
+ * #305: ws.terminate() is undefined in browsers.
+ * This only works in node.js, not in browsers.
+ * Does nothing if `ws` is undefined. Does nothing in browsers.
+ */
+function safeTerminateWs(ws, fallbackToClose) {
+    if (!ws) {
+        return false;
+    }
+    if (typeof ws['terminate'] === 'function') {
+        ws.terminate();
+        return true;
+    }
+    else if (fallbackToClose) {
+        ws.close();
+    }
+    return false;
+}
+/**
+ * Users can conveniently pass topics as strings or objects (object has topic name + optional params).
+ *
+ * This method normalises topics into objects (object has topic name + optional params).
+ */
+function getNormalisedTopicRequests(wsTopicRequests) {
+    const normalisedTopicRequests = [];
+    for (const wsTopicRequest of wsTopicRequests) {
+        // passed as string, convert to object
+        if (typeof wsTopicRequest === 'string') {
+            const topicRequest = {
+                topic: wsTopicRequest,
+                payload: undefined,
+            };
+            normalisedTopicRequests.push(topicRequest);
+            continue;
+        }
+        // already a normalised object, thanks to user
+        normalisedTopicRequests.push(wsTopicRequest);
+    }
+    return normalisedTopicRequests;
+}
+/**
+ * WebSocket.ping() is not available in browsers. This is a simple check used to
+ * disable heartbeats in browers, for exchanges that use native WebSocket ping/pong frames.
+ */
+function isWSPingFrameAvailable() {
+    return typeof WebSocket.prototype['ping'] === 'function';
+}
+/**
+ * WebSocket.pong() is not available in browsers. This is a simple check used to
+ * disable heartbeats in browers, for exchanges that use native WebSocket ping/pong frames.
+ */
+function isWSPongFrameAvailable() {
+    return typeof WebSocket.prototype['pong'] === 'function';
+}
+/**
+ * WS API promises are stored using a primary key. This key is constructed using
+ * properties found in every request & reply.
+ */
+function getPromiseRefForWSAPIRequest(requestEvent) {
+    const promiseRef = [requestEvent.id, requestEvent.op].join('_');
+    return promiseRef;
+}
+//# sourceMappingURL=websocket-util.js.map

package/dist/cjs/util/websocket-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../../src/util/websocket-util.ts"],"names":[],"mappings":";;;AA+KA,oCAsCC;AA4HD,0DAUC;AAKD,8CAgCC;AAED,4CAgCC;AAED,4CAWC;AAKD,4CAkDC;AAED,wFAcC;AAED,4BAQC;AAaD,0CAeC;AA6BD,gEAoBC;AAMD,wDAEC;AAMD,wDAEC;AAMD,oEAKC;AAvmBD,6DAIuC;AAIvC,uDAA8C;AAC9C,mDAA6C;AAEhC,QAAA,kBAAkB,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAE5C,QAAA,eAAe,GAGxB;IACF,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,MAAM,EAAE,oCAAoC;YAC5C,OAAO,EAAE,qCAAqC;YAC9C,6HAA6H;YAC7H,QAAQ,EAAE,sCAAsC;SACjD;QACD,IAAI,EAAE;YACJ,MAAM,EAAE,uCAAuC;YAC/C,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,uDAAuD;SAClE;KACF;IACD,6BAA6B;IAC7B,iHAAiH;IACjH,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,MAAM,EAAE,oCAAoC;YAC5C,OAAO,EAAE,qCAAqC;YAC9C,6HAA6H;YAC7H,QAAQ,EAAE,sCAAsC;SACjD;QACD,IAAI,EAAE;YACJ,MAAM,EAAE,uCAAuC;YAC/C,OAAO,EAAE,wCAAwC;YACjD,QAAQ,EAAE,uDAAuD;SAClE;KACF;IACD,iGAAiG;IACjG,GAAG,EAAE;QACH,IAAI,EAAE;YACJ,MAAM,EAAE,uCAAuC;YAC/C,OAAO,EAAE,wCAAwC;YACjD,6HAA6H;YAC7H,QAAQ,EAAE,yCAAyC;SACpD;QACD,IAAI,EAAE;YACJ,MAAM,EAAE,0CAA0C;YAClD,OAAO,EAAE,2CAA2C;YACpD,QAAQ,EAAE,0DAA0D;SACrE;KACF;IACD,mGAAmG;IACnG,EAAE,EAAE;QACF,IAAI,EAAE;YACJ,MAAM,EAAE,sCAAsC;YAC9C,OAAO,EAAE,uCAAuC;YAChD,6HAA6H;YAC7H,QAAQ,EAAE,wCAAwC;SACnD;QACD,IAAI,EAAE;YACJ,MAAM,EAAE,yCAAyC;YACjD,OAAO,EAAE,0CAA0C;YACnD,QAAQ,EAAE,yDAAyD;SACpE;KACF;CACF,CAAC;AAEW,QAAA,UAAU,GAAG;IACxB,mFAAmF;IACnF;;OAEG;IACH,UAAU,EAAE,YAAY;IACxB;;OAEG;IACH,WAAW,EAAE,aAAa;IAC1B;;OAEG;IACH,YAAY,EAAE,cAAc;IAC5B;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAChC;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAClC;;OAEG;IACH,gBAAgB,EAAE,kBAAkB;IACpC,iGAAiG;IACjG;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAChC;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAClC;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAChC;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAClC,mGAAmG;IACnG;;OAEG;IACH,YAAY,EAAE,cAAc;IAC5B;;OAEG;IACH,aAAa,EAAE,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAChC,YAAY,EAAE,cAAc;IAC5B,aAAa,EAAE,eAAe;IAC9B,cAAc,EAAE,gBAAgB;CACxB,CAAC;AAKE,QAAA,eAAe,GAAY;IACtC,kBAAU,CAAC,WAAW;IACtB,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,eAAe;IAC1B,kBAAU,CAAC,gBAAgB;IAC3B,kBAAU,CAAC,cAAc;IACzB,kBAAU,CAAC,eAAe;IAC1B,kBAAU,CAAC,cAAc;IACzB,kBAAU,CAAC,eAAe;IAC1B,kBAAU,CAAC,aAAa;IACxB,kBAAU,CAAC,cAAc;IACzB,kBAAU,CAAC,aAAa;IACxB,kBAAU,CAAC,cAAc;CAC1B,CAAC;AAEW,QAAA,cAAc,GAAY;IACrC,kBAAU,CAAC,UAAU;IACrB,kBAAU,CAAC,cAAc;IACzB,kBAAU,CAAC,aAAa;IACxB,kBAAU,CAAC,aAAa;IACxB,kBAAU,CAAC,YAAY;IACvB,kBAAU,CAAC,YAAY;CACxB,CAAC;AAEF;;GAEG;AACH,SAAgB,YAAY,CAAC,KAAY;IACvC,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,kBAAU,CAAC,cAAc,CAAC;QAC/B,KAAK,kBAAU,CAAC,eAAe,CAAC;QAChC,KAAK,kBAAU,CAAC,gBAAgB,CAAC;QACjC,KAAK,kBAAU,CAAC,aAAa,CAAC;QAC9B,KAAK,kBAAU,CAAC,cAAc,CAAC;QAC/B,KAAK,kBAAU,CAAC,eAAe,CAAC;QAChC,KAAK,kBAAU,CAAC,YAAY,CAAC;QAC7B,KAAK,kBAAU,CAAC,aAAa,CAAC;QAC9B,KAAK,kBAAU,CAAC,cAAc,CAAC,CAAC,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,kBAAU,CAAC,UAAU;YACxB,OAAO,kBAAU,CAAC,cAAc,CAAC;QACnC,KAAK,kBAAU,CAAC,WAAW;YACzB,OAAO,kBAAU,CAAC,gBAAgB,CAAC;QACrC,KAAK,kBAAU,CAAC,YAAY;YAC1B,OAAO,kBAAU,CAAC,gBAAgB,CAAC;QAErC,KAAK,kBAAU,CAAC,aAAa;YAC3B,OAAO,kBAAU,CAAC,aAAa,CAAC;QAClC,KAAK,kBAAU,CAAC,cAAc;YAC5B,OAAO,kBAAU,CAAC,cAAc,CAAC;QACnC,KAAK,kBAAU,CAAC,eAAe;YAC7B,OAAO,kBAAU,CAAC,eAAe,CAAC;QAEpC,KAAK,kBAAU,CAAC,YAAY;YAC1B,OAAO,kBAAU,CAAC,YAAY,CAAC;QACjC,KAAK,kBAAU,CAAC,aAAa;YAC3B,OAAO,kBAAU,CAAC,aAAa,CAAC;QAClC,KAAK,kBAAU,CAAC,cAAc;YAC5B,OAAO,kBAAU,CAAC,cAAc,CAAC;QAEnC;YACE,MAAM,IAAA,0BAAU,EAAC,KAAK,EAAE,oBAAoB,KAAK,GAAG,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED,gHAAgH;AAChH,MAAM,gBAAgB,GAAG;IACvB,SAAS;IACT,WAAW;IACX,sBAAsB;IACtB,QAAQ;IACR,aAAa;IACb,cAAc;IACd,qBAAqB;IACrB,gBAAgB;IAChB,kBAAkB;IAClB,sBAAsB;IACtB,kBAAkB;IAClB,gBAAgB;IAChB,iBAAiB;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,iBAAiB,GAAG;IACxB,aAAa;IACb,cAAc;IACd,cAAc;IACd,iBAAiB;IACjB,kBAAkB;IAClB,sBAAsB;IACtB,kBAAkB;IAClB,gBAAgB;IAChB,iBAAiB;IACjB,oBAAoB;IACpB,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,WAAW;IACX,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,WAAW;IACX,WAAW;IACX,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IACV,aAAa;IACb,aAAa;IACb,aAAa;IACb,aAAa;IACb,aAAa;IACb,aAAa;IACb,aAAa;IACb,aAAa;IACb,cAAc;IACd,aAAa;IACb,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,sBAAsB;IACtB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,sBAAsB;IACtB,sBAAsB;IACtB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,wBAAwB;IACxB,wBAAwB;IACxB,wBAAwB;IACxB,wBAAwB;IACxB,wBAAwB;IACxB,wBAAwB;IACxB,wBAAwB;IACxB,wBAAwB;IACxB,yBAAyB;IACzB,wBAAwB;IACxB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,iBAAiB;IACjB,gBAAgB;IAChB,gCAAgC;IAChC,gBAAgB;IAChB,iBAAiB;IACjB,iBAAiB;IACjB,gBAAgB;IAChB,gBAAgB;IAChB,gBAAgB;IAChB,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;IACnB,oBAAoB;IACpB,mBAAmB;CACpB,CAAC;AAEF,iEAAiE;AACjE,SAAgB,uBAAuB,CACrC,MAAiB,EACjB,OAAkB,EAClB,SAAmB;IAEnB,MAAM,cAAc,GAClB,SAAS,KAAK,IAAI,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAE9D,OAAO,iBAAiB,CAAC,MAAM,EAAE,cAAc,EAAE,iBAAiB,CAAC,CAAC;AACtE,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAC/B,MAAiB,EACjB,SAAkB,EAClB,iBAA0B;IAE1B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,iBAAiB,EAAE,CAAC;gBACtB,OAAO,kBAAU,CAAC,YAAY,CAAC;YACjC,CAAC;YACD,OAAO,SAAS,CAAC,CAAC,CAAC,kBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,kBAAU,CAAC,UAAU,CAAC;QACpE,CAAC;QACD,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,IAAI,iBAAiB,EAAE,CAAC;gBACtB,OAAO,kBAAU,CAAC,eAAe,CAAC;YACpC,CAAC;YACD,OAAO,SAAS,CAAC,CAAC,CAAC,kBAAU,CAAC,cAAc,CAAC,CAAC,CAAC,kBAAU,CAAC,aAAa,CAAC;QAC1E,CAAC;QACD,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,IAAI,iBAAiB,EAAE,CAAC;gBACtB,OAAO,kBAAU,CAAC,cAAc,CAAC;YACnC,CAAC;YACD,OAAO,SAAS,CAAC,CAAC,CAAC,kBAAU,CAAC,aAAa,CAAC,CAAC,CAAC,kBAAU,CAAC,YAAY,CAAC;QACxE,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,0BAAU,EACd,MAAM,EACN,yCAAyC,MAAM,GAAG,CACnD,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,gBAAgB,CAC9B,SAAyB,EACzB,KAAY;IAEZ,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,kBAAU,CAAC,UAAU,CAAC;QAC3B,KAAK,kBAAU,CAAC,cAAc,CAAC;QAC/B,KAAK,kBAAU,CAAC,aAAa,CAAC;QAC9B,KAAK,kBAAU,CAAC,aAAa,CAAC;QAC9B,KAAK,kBAAU,CAAC,YAAY,CAAC;QAC7B,KAAK,kBAAU,CAAC,YAAY;YAC1B,OAAO,KAAK,CAAC;QAEf,KAAK,kBAAU,CAAC,eAAe,CAAC;QAChC,KAAK,kBAAU,CAAC,gBAAgB,CAAC;QACjC,KAAK,kBAAU,CAAC,cAAc,CAAC;QAC/B,KAAK,kBAAU,CAAC,eAAe,CAAC;QAChC,KAAK,kBAAU,CAAC,aAAa,CAAC;QAC9B,KAAK,kBAAU,CAAC,cAAc,CAAC;QAC/B,KAAK,kBAAU,CAAC,WAAW,CAAC;QAC5B,KAAK,kBAAU,CAAC,YAAY,CAAC;QAE7B,KAAK,kBAAU,CAAC,cAAc,CAAC;QAC/B,KAAK,kBAAU,CAAC,eAAe,CAAC;QAChC,KAAK,kBAAU,CAAC,aAAa,CAAC;QAC9B,KAAK,kBAAU,CAAC,cAAc;YAC5B,OAAO,iCAAqB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEnD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,0BAAU,EAAC,KAAK,EAAE,oBAAoB,KAAK,GAAG,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,gBAAgB,CAC9B,OAA6B,EAC7B,KAAY;IAEZ,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;QACzC,OAAO;IACT,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,2BAAS,CAAC;IACrC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAC9B,KAAY,EACZ,eAAuC,EACvC,MAA4B;IAE5B,IAAI,eAAe,CAAC,KAAK,EAAE,CAAC;QAC1B,OAAO,eAAe,CAAC,KAAK,CAAC;IAC/B,CAAC;IACD,MAAM,aAAa,GAAG,CAAC,CAAC,eAAe,EAAE,WAAW,CAAC;IACrD,MAAM,YAAY,GAAoB,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;IACtE,QAAQ,KAAK,EAAE,CAAC;QACd,uBAAuB;QACvB,KAAK,YAAY,CAAC;QAClB,KAAK,gBAAgB;YACnB,OAAO,uBAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC;QACrD,KAAK,aAAa,CAAC;QACnB,KAAK,iBAAiB;YACpB,OAAO,uBAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC;QACtD,KAAK,cAAc,CAAC;QACpB,KAAK,kBAAkB;YACrB,OAAO,uBAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC;QACvD,mBAAmB;QACnB,KAAK,eAAe,CAAC;QACrB,KAAK,eAAe;YAClB,OAAO,uBAAe,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC;QAClD,KAAK,gBAAgB,CAAC;QACtB,KAAK,gBAAgB;YACnB,OAAO,uBAAe,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC;QACnD,KAAK,iBAAiB,CAAC;QACvB,KAAK,iBAAiB;YACpB,OAAO,uBAAe,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC;QACpD,mBAAmB;QACnB,KAAK,cAAc,CAAC;QACpB,KAAK,cAAc;YACjB,OAAO,uBAAe,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC;QACjD,KAAK,eAAe,CAAC;QACrB,KAAK,eAAe;YAClB,OAAO,uBAAe,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC;QAClD,KAAK,gBAAgB,CAAC;QACtB,KAAK,gBAAgB;YACnB,OAAO,uBAAe,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC;QACnD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,YAAY,GAAG,+BAA+B,CAAC;YACrD,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE;gBACzB,QAAQ,EAAE,QAAQ;gBAClB,KAAK;aACN,CAAC,CAAC;YACH,MAAM,IAAA,0BAAU,EAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,sCAAsC,CACpD,MAAiB;IAEjB,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM,CAAC;QACZ,KAAK,KAAK,CAAC;QACX,KAAK,QAAQ,CAAC;QACd,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,0BAAU,EAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,CAAC,KAAK;QACP,MAAM,IAAI,KAAK;QACf,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,QAAQ;QACjC,KAAK,CAAC,MAAM,CAAC,KAAK,MAAM,CACzB,CAAC;AACJ,CAAC;AAEY,QAAA,kBAAkB,GAAG;IAChC,EAAE,EAAE,GAAG;IACP,YAAY,EAAE,OAAO;IACrB,sBAAsB,EAAE,OAAO;CAChC,CAAC;AAEF;;;;GAIG;AACH,SAAgB,eAAe,CAC7B,EAAoB,EACpB,eAAyB;IAEzB,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,UAAU,EAAE,CAAC;QAC1C,EAAE,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,eAAe,EAAE,CAAC;QAC3B,EAAE,CAAC,KAAK,EAAE,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAwBD;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,eAAsD;IAEtD,MAAM,uBAAuB,GAA6B,EAAE,CAAC;IAE7D,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;QAC7C,sCAAsC;QACtC,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,YAAY,GAA2B;gBAC3C,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,SAAS;aACnB,CAAC;YACF,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3C,SAAS;QACX,CAAC;QAED,8CAA8C;QAC9C,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB;IACpC,OAAO,OAAQ,SAAS,CAAC,SAAiB,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;AACpE,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB;IACpC,OAAO,OAAQ,SAAS,CAAC,SAAiB,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;AACpE,CAAC;AAED;;;GAGG;AACH,SAAgB,4BAA4B,CAC1C,YAAsC;IAEtC,MAAM,UAAU,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/cjs/websocket-api-client.d.ts

@@ -0,0 +1,135 @@
+import { OrderIdRequest } from './types/rest/request/trade.js';
+import { OrderResult } from './types/rest/response/private-trade.js';
+import { WSAPIResponse } from './types/websockets/ws-api.js';
+import { WSAPIAmendOrderRequestV5, WSAPIAmendSpreadOrderRequestV5, WSAPICancelSpreadOrderRequestV5, WSAPIMassCancelOrdersRequestV5, WSAPIPlaceOrderRequestV5, WSAPIPlaceSpreadOrderRequestV5, WSAPISpreadMassCancelOrdersRequestV5 } from './types/websockets/ws-api-request.js';
+import { WSAPICancelOrderResultV5, WSAPISpreadAmendOrderResultV5, WSAPISpreadCancelOrderResultV5, WSAPISpreadPlaceOrderResultV5 } from './types/websockets/ws-api-response.js';
+import { WSClientConfigurableOptions } from './types/websockets/ws-general.js';
+import { DefaultLogger } from './util/logger.js';
+import { WebsocketClient } from './websocket-client.js';
+/**
+ * Configurable options specific to only the REST-like WebsocketAPIClient
+ */
+export interface WSAPIClientConfigurableOptions {
+    /**
+     * Default: true
+     *
+     * Attach default event listeners, which will console log any high level
+     * events (opened/reconnecting/reconnected/etc).
+     *
+     * If you disable this, you should set your own event listeners
+     * on the embedded WS Client `wsApiClient.getWSClient().on(....)`.
+     */
+    attachEventListeners: boolean;
+}
+/**
+ * This is a minimal Websocket API wrapper around the WebsocketClient. It allows you to use the WebSocket API in a promise-driven way, send a request and await the response.
+ *
+ * Note: You can also directly use the sendWSAPIRequest() method to make WS API calls, but some
+ * may find the below methods slightly more intuitive.
+ *
+ * Refer to the WS API promises example for a more detailed example on using sendWSAPIRequest() directly:
+ * https://github.com/tiagosiebler/okx-api/blob/master/examples/ws-api-trade-raw.ts
+ */
+export declare class WebsocketAPIClient {
+    private wsClient;
+    private options;
+    constructor(options?: WSClientConfigurableOptions & Partial<WSAPIClientConfigurableOptions>, logger?: DefaultLogger);
+    getWSClient(): WebsocketClient;
+    setTimeOffsetMs(newOffset: number): void;
+    /**
+     *
+     *
+     * OKX WebSocket API Methods
+     *
+     *
+     */
+    /**
+     * Submit a new order
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
+     */
+    submitNewOrder(params: WSAPIPlaceOrderRequestV5): Promise<WSAPIResponse<[OrderResult], 'order'>>;
+    /**
+     * Submit multiple orders in a batch
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
+     */
+    submitMultipleOrders(params: WSAPIPlaceOrderRequestV5[]): Promise<WSAPIResponse<OrderResult[], 'batch-orders'>>;
+    /**
+     * Cancel a single order
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
+     */
+    cancelOrder(params: OrderIdRequest): Promise<WSAPIResponse<[WSAPICancelOrderResultV5], 'cancel-order'>>;
+    /**
+     * Cancel multiple orders
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
+     */
+    cancelMultipleOrders(params: OrderIdRequest[]): Promise<WSAPIResponse<WSAPICancelOrderResultV5[], 'batch-cancel-orders'>>;
+    /**
+     * Amend a single order
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
+     */
+    amendOrder(params: WSAPIAmendOrderRequestV5): Promise<WSAPIResponse<[OrderResult], 'amend-order'>>;
+    /**
+     * Amend multiple orders
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
+     */
+    amendMultipleOrders(params: WSAPIAmendOrderRequestV5[]): Promise<WSAPIResponse<[OrderResult], 'batch-amend-orders'>>;
+    /**
+     * Mass cancel orders
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
+     */
+    massCancelOrders(params: WSAPIMassCancelOrdersRequestV5): Promise<WSAPIResponse<[{
+        result: boolean;
+    }], 'mass-cancel'>>;
+    /**
+     * Submit a new spread order
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
+     */
+    submitSpreadOrder(params: WSAPIPlaceSpreadOrderRequestV5): Promise<WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], 'sprd-order'>>;
+    /**
+     * Amend a spread order
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
+     */
+    amendSpreadOrder(params: WSAPIAmendSpreadOrderRequestV5): Promise<WSAPIResponse<[WSAPISpreadAmendOrderResultV5], 'sprd-amend-order'>>;
+    /**
+     * Cancel a spread order
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
+     */
+    cancelSpreadOrder(params: WSAPICancelSpreadOrderRequestV5): Promise<WSAPIResponse<[WSAPISpreadCancelOrderResultV5], 'sprd-cancel-order'>>;
+    /**
+     * Mass cancel spread orders
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders
+     */
+    massCancelSpreadOrders(params: WSAPISpreadMassCancelOrdersRequestV5): Promise<WSAPIResponse<[{
+        result: boolean;
+    }], 'sprd-mass-cancel'>>;
+    /**
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     * Private methods for handling some of the convenience/automation provided by the WS API Client
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     */
+    connectWSAPI(): Promise<unknown[]>;
+    private setupDefaultEventListeners;
+}