okx-api 2.0.6 → 3.0.0-beta.0

package/lib/util/websocket-util.js

@@ -1,282 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeTerminateWs = exports.WS_EVENT_CODE_ENUM = exports.isWsPong = exports.getMaxTopicsPerSubscribeEvent = exports.getWsUrlForWsKey = exports.getWsKeyForMarket = exports.getWsKeyForTopicChannel = exports.PUBLIC_WS_KEYS = exports.PRIVATE_WS_KEYS = exports.WS_KEY_MAP = exports.WS_BASE_URL_MAP = void 0;
-const typeGuards_1 = require("./typeGuards");
-exports.WS_BASE_URL_MAP = {
-    prod: {
-        public: 'wss://ws.okx.com:8443/ws/v5/public',
-        private: 'wss://ws.okx.com:8443/ws/v5/private',
-    },
-    business: {
-        public: 'wss://ws.okx.com:8443/ws/v5/business',
-        private: 'wss://ws.okx.com:8443/ws/v5/business',
-    },
-    businessDemo: {
-        public: 'wss://wspap.okx.com:8443/ws/v5/business?brokerId=9999',
-        private: 'wss://wspap.okx.com:8443/ws/v5/business?brokerId=9999',
-    },
-    demo: {
-        public: 'wss://wspap.okx.com:8443/ws/v5/public?brokerId=9999',
-        private: 'wss://wspap.okx.com:8443/ws/v5/private?brokerId=9999',
-    },
-};
-exports.WS_KEY_MAP = {
-    prodPublic: 'prodPublic',
-    prodPrivate: 'prodPrivate',
-    demoPublic: 'demoPublic',
-    demoPrivate: 'demoPrivate',
-    businessPrivate: 'businessPrivate',
-    businessPublic: 'businessPublic',
-    businessDemoPublic: 'businessDemoPublic',
-    businessDemoPrivate: 'businessDemoPrivate',
-};
-exports.PRIVATE_WS_KEYS = [
-    exports.WS_KEY_MAP.prodPrivate,
-    exports.WS_KEY_MAP.businessPrivate,
-    exports.WS_KEY_MAP.demoPrivate,
-    exports.WS_KEY_MAP.businessDemoPrivate,
-];
-exports.PUBLIC_WS_KEYS = [
-    exports.WS_KEY_MAP.prodPublic,
-    exports.WS_KEY_MAP.businessPublic,
-    exports.WS_KEY_MAP.demoPublic,
-    exports.WS_KEY_MAP.businessDemoPublic,
-];
-/** 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);
-}
-exports.getWsKeyForTopicChannel = getWsKeyForTopicChannel;
-function getWsKeyForMarket(market, isPrivate, isBusinessChannel) {
-    switch (market) {
-        case 'prod': {
-            if (isBusinessChannel) {
-                return isPrivate
-                    ? exports.WS_KEY_MAP.businessPrivate
-                    : exports.WS_KEY_MAP.businessPublic;
-            }
-            return isPrivate ? exports.WS_KEY_MAP.prodPrivate : exports.WS_KEY_MAP.prodPublic;
-        }
-        case 'demo': {
-            if (isBusinessChannel) {
-                return isPrivate
-                    ? exports.WS_KEY_MAP.businessDemoPrivate
-                    : exports.WS_KEY_MAP.businessDemoPublic;
-            }
-            return isPrivate ? exports.WS_KEY_MAP.demoPrivate : exports.WS_KEY_MAP.demoPublic;
-        }
-        case 'business': {
-            return isPrivate ? exports.WS_KEY_MAP.businessPrivate : exports.WS_KEY_MAP.businessPublic;
-        }
-        case 'businessDemo': {
-            return isPrivate
-                ? exports.WS_KEY_MAP.businessDemoPrivate
-                : exports.WS_KEY_MAP.businessDemoPublic;
-        }
-        default: {
-            throw (0, typeGuards_1.neverGuard)(market, 'getWsKeyForTopic(): Unhandled market');
-        }
-    }
-}
-exports.getWsKeyForMarket = getWsKeyForMarket;
-/** Maps a WS key back to a WS URL */
-function getWsUrlForWsKey(wsKey, wsClientOptions, logger) {
-    if (wsClientOptions.wsUrl) {
-        return wsClientOptions.wsUrl;
-    }
-    switch (wsKey) {
-        case 'prodPublic':
-            return exports.WS_BASE_URL_MAP.prod.public;
-        case 'prodPrivate':
-            return exports.WS_BASE_URL_MAP.prod.private;
-        case 'demoPublic':
-            return exports.WS_BASE_URL_MAP.demo.public;
-        case 'demoPrivate':
-            return exports.WS_BASE_URL_MAP.demo.private;
-        case 'businessPublic':
-            return exports.WS_BASE_URL_MAP.business.public;
-        case 'businessPrivate':
-            return exports.WS_BASE_URL_MAP.business.private;
-        case 'businessDemoPublic':
-            return exports.WS_BASE_URL_MAP.businessDemo.public;
-        case 'businessDemoPrivate':
-            return exports.WS_BASE_URL_MAP.businessDemo.private;
-        default: {
-            const errorMessage = 'getWsUrl(): Unhandled wsKey: ';
-            logger.error(errorMessage, {
-                category: 'okx-ws',
-                wsKey,
-            });
-            throw (0, typeGuards_1.neverGuard)(wsKey, errorMessage);
-        }
-    }
-}
-exports.getWsUrlForWsKey = getWsUrlForWsKey;
-function getMaxTopicsPerSubscribeEvent(market) {
-    switch (market) {
-        case 'prod':
-        case 'demo':
-        case 'business':
-        case 'businessDemo': {
-            return null;
-        }
-        default: {
-            throw (0, typeGuards_1.neverGuard)(market, 'getWsKeyForTopic(): Unhandled market');
-        }
-    }
-}
-exports.getMaxTopicsPerSubscribeEvent = getMaxTopicsPerSubscribeEvent;
-function isWsPong(event) {
-    return (typeof event === 'object' &&
-        !!event &&
-        'data' in event &&
-        typeof event['data'] === 'string' &&
-        event['data'] === 'pong');
-}
-exports.isWsPong = isWsPong;
-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;
-}
-exports.safeTerminateWs = safeTerminateWs;
-//# sourceMappingURL=websocket-util.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"websocket-util.js","sourceRoot":"","sources":["../../src/util/websocket-util.ts"],"names":[],"mappings":";;;AAEA,6CAA0C;AAE7B,QAAA,eAAe,GAGxB;IACF,IAAI,EAAE;QACJ,MAAM,EAAE,oCAAoC;QAC5C,OAAO,EAAE,qCAAqC;KAC/C;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,sCAAsC;QAC9C,OAAO,EAAE,sCAAsC;KAChD;IACD,YAAY,EAAE;QACZ,MAAM,EAAE,uDAAuD;QAC/D,OAAO,EAAE,uDAAuD;KACjE;IACD,IAAI,EAAE;QACJ,MAAM,EAAE,qDAAqD;QAC7D,OAAO,EAAE,sDAAsD;KAChE;CACF,CAAC;AAEW,QAAA,UAAU,GAAG;IACxB,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;IAChC,kBAAkB,EAAE,oBAAoB;IACxC,mBAAmB,EAAE,qBAAqB;CAClC,CAAC;AAKE,QAAA,eAAe,GAAY;IACtC,kBAAU,CAAC,WAAW;IACtB,kBAAU,CAAC,eAAe;IAC1B,kBAAU,CAAC,WAAW;IACtB,kBAAU,CAAC,mBAAmB;CAC/B,CAAC;AAEW,QAAA,cAAc,GAAY;IACrC,kBAAU,CAAC,UAAU;IACrB,kBAAU,CAAC,cAAc;IACzB,kBAAU,CAAC,UAAU;IACrB,kBAAU,CAAC,kBAAkB;CAC9B,CAAC;AAEF,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;AAVD,0DAUC;AAED,SAAgB,iBAAiB,CAC/B,MAAiB,EACjB,SAAkB,EAClB,iBAA0B;IAE1B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,IAAI,iBAAiB,EAAE,CAAC;gBACtB,OAAO,SAAS;oBACd,CAAC,CAAC,kBAAU,CAAC,eAAe;oBAC5B,CAAC,CAAC,kBAAU,CAAC,cAAc,CAAC;YAChC,CAAC;YACD,OAAO,SAAS,CAAC,CAAC,CAAC,kBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,kBAAU,CAAC,UAAU,CAAC;QACpE,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,IAAI,iBAAiB,EAAE,CAAC;gBACtB,OAAO,SAAS;oBACd,CAAC,CAAC,kBAAU,CAAC,mBAAmB;oBAChC,CAAC,CAAC,kBAAU,CAAC,kBAAkB,CAAC;YACpC,CAAC;YACD,OAAO,SAAS,CAAC,CAAC,CAAC,kBAAU,CAAC,WAAW,CAAC,CAAC,CAAC,kBAAU,CAAC,UAAU,CAAC;QACpE,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO,SAAS,CAAC,CAAC,CAAC,kBAAU,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAU,CAAC,cAAc,CAAC;QAC5E,CAAC;QACD,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,OAAO,SAAS;gBACd,CAAC,CAAC,kBAAU,CAAC,mBAAmB;gBAChC,CAAC,CAAC,kBAAU,CAAC,kBAAkB,CAAC;QACpC,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,uBAAU,EAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAlCD,8CAkCC;AAED,qCAAqC;AACrC,SAAgB,gBAAgB,CAC9B,KAAY,EACZ,eAAuC,EACvC,MAA4B;IAE5B,IAAI,eAAe,CAAC,KAAK,EAAE,CAAC;QAC1B,OAAO,eAAe,CAAC,KAAK,CAAC;IAC/B,CAAC;IAED,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,YAAY;YACf,OAAO,uBAAe,CAAC,IAAI,CAAC,MAAM,CAAC;QACrC,KAAK,aAAa;YAChB,OAAO,uBAAe,CAAC,IAAI,CAAC,OAAO,CAAC;QACtC,KAAK,YAAY;YACf,OAAO,uBAAe,CAAC,IAAI,CAAC,MAAM,CAAC;QACrC,KAAK,aAAa;YAChB,OAAO,uBAAe,CAAC,IAAI,CAAC,OAAO,CAAC;QACtC,KAAK,gBAAgB;YACnB,OAAO,uBAAe,CAAC,QAAQ,CAAC,MAAM,CAAC;QACzC,KAAK,iBAAiB;YACpB,OAAO,uBAAe,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1C,KAAK,oBAAoB;YACvB,OAAO,uBAAe,CAAC,YAAY,CAAC,MAAM,CAAC;QAC7C,KAAK,qBAAqB;YACxB,OAAO,uBAAe,CAAC,YAAY,CAAC,OAAO,CAAC;QAC9C,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,uBAAU,EAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;AACH,CAAC;AAnCD,4CAmCC;AAED,SAAgB,6BAA6B,CAC3C,MAAiB;IAEjB,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU,CAAC;QAChB,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,uBAAU,EAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAdD,sEAcC;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;AARD,4BAQC;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;AAfD,0CAeC"}