okx-api 2.0.7 → 3.0.0-beta.0

package/dist/cjs/websocket-api-client.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebsocketAPIClient = void 0;
+const websocket_client_js_1 = require("./websocket-client.js");
+/**
+ * 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
+ */
+class WebsocketAPIClient {
+    wsClient;
+    options;
+    constructor(options, logger) {
+        this.wsClient = new websocket_client_js_1.WebsocketClient(options, logger);
+        this.options = {
+            attachEventListeners: true,
+            ...options,
+        };
+        this.setupDefaultEventListeners();
+    }
+    getWSClient() {
+        return this.wsClient;
+    }
+    setTimeOffsetMs(newOffset) {
+        return this.getWSClient().setTimeOffsetMs(newOffset);
+    }
+    /**
+     *
+     *
+     * OKX WebSocket API Methods
+     *
+     *
+     */
+    /**
+     * Submit a new order
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
+     */
+    submitNewOrder(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('private'), 'order', params);
+    }
+    /**
+     * Submit multiple orders in a batch
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
+     */
+    submitMultipleOrders(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('private'), 'batch-orders', params);
+    }
+    /**
+     * Cancel a single order
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
+     */
+    cancelOrder(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('private'), 'cancel-order', params);
+    }
+    /**
+     * Cancel multiple orders
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
+     */
+    cancelMultipleOrders(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('private'), 'batch-cancel-orders', params);
+    }
+    /**
+     * Amend a single order
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
+     */
+    amendOrder(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('private'), 'amend-order', params);
+    }
+    /**
+     * Amend multiple orders
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
+     */
+    amendMultipleOrders(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('private'), 'batch-amend-orders', params);
+    }
+    /**
+     * Mass cancel orders
+     *
+     * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
+     */
+    massCancelOrders(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('private'), 'mass-cancel', params);
+    }
+    /**
+     * Submit a new spread order
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
+     */
+    submitSpreadOrder(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('business'), 'sprd-order', params);
+    }
+    /**
+     * Amend a spread order
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
+     */
+    amendSpreadOrder(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('business'), 'sprd-amend-order', params);
+    }
+    /**
+     * Cancel a spread order
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
+     */
+    cancelSpreadOrder(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('business'), 'sprd-cancel-order', params);
+    }
+    /**
+     * Mass cancel spread orders
+     *
+     * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders
+     */
+    massCancelSpreadOrders(params) {
+        return this.wsClient.sendWSAPIRequest(this.getWSClient().getMarketWsKey('business'), 'sprd-mass-cancel', params);
+    }
+    /**
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     * Private methods for handling some of the convenience/automation provided by the WS API Client
+     *
+     *
+     *
+     *
+     *
+     *
+     *
+     */
+    connectWSAPI() {
+        return this.getWSClient().connectWSAPI();
+    }
+    setupDefaultEventListeners() {
+        if (this.options.attachEventListeners) {
+            /**
+             * General event handlers for monitoring the WebsocketClient
+             */
+            this.wsClient
+                .on('open', (data) => {
+                console.log(new Date(), 'ws connected', data.wsKey);
+            })
+                .on('reconnect', ({ wsKey }) => {
+                console.log(new Date(), 'ws automatically reconnecting.... ', wsKey);
+            })
+                .on('reconnected', (data) => {
+                console.log(new Date(), 'ws has reconnected ', data?.wsKey);
+            })
+                .on('authenticated', (data) => {
+                console.info(new Date(), 'ws has authenticated ', data?.wsKey);
+            })
+                .on('exception', (data) => {
+                console.error(new Date(), 'ws exception: ', JSON.stringify(data));
+            });
+        }
+    }
+}
+exports.WebsocketAPIClient = WebsocketAPIClient;
+//# sourceMappingURL=websocket-api-client.js.map

package/dist/cjs/websocket-api-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket-api-client.js","sourceRoot":"","sources":["../../src/websocket-api-client.ts"],"names":[],"mappings":";;;AAoBA,+DAAwD;AAkBxD;;;;;;;;GAQG;AACH,MAAa,kBAAkB;IACrB,QAAQ,CAAkB;IAE1B,OAAO,CAA+D;IAE9E,YACE,OACyC,EACzC,MAAsB;QAEtB,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAe,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAErD,IAAI,CAAC,OAAO,GAAG;YACb,oBAAoB,EAAE,IAAI;YAC1B,GAAG,OAAO;SACX,CAAC;QAEF,IAAI,CAAC,0BAA0B,EAAE,CAAC;IACpC,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,eAAe,CAAC,SAAiB;QACtC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IAEH;;;;OAIG;IACH,cAAc,CACZ,MAAgC;QAEhC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,OAAO,EACP,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAClB,MAAkC;QAElC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,cAAc,EACd,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,MAAsB;QAEtB,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,cAAc,EACd,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAClB,MAAwB;QAExB,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,qBAAqB,EACrB,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,UAAU,CACR,MAAgC;QAEhC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,aAAa,EACb,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CACjB,MAAkC;QAElC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,oBAAoB,EACpB,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CACd,MAAsC;QAEtC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,aAAa,EACb,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,MAAsC;QAEtC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,EAC7C,YAAY,EACZ,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CACd,MAAsC;QAItC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,EAC7C,kBAAkB,EAClB,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,MAAuC;QAIvC,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,EAC7C,mBAAmB,EACnB,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CACpB,MAA4C;QAE5C,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CACnC,IAAI,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,EAC7C,kBAAkB,EAClB,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IAEI,YAAY;QACjB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC;IAC3C,CAAC;IAEO,0BAA0B;QAChC,IAAI,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACtC;;eAEG;YACH,IAAI,CAAC,QAAQ;iBACV,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;gBACnB,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACtD,CAAC,CAAC;iBACD,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;gBAC7B,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,oCAAoC,EAAE,KAAK,CAAC,CAAC;YACvE,CAAC,CAAC;iBACD,EAAE,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC1B,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC;iBACD,EAAE,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,uBAAuB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YACjE,CAAC,CAAC;iBACD,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;gBACxB,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACP,CAAC;IACH,CAAC;CACF;AA1PD,gDA0PC"}

package/{lib/websocket-client.d.ts → dist/cjs/websocket-client-legacy.d.ts}

@@ -1,45 +1,24 @@
 import { EventEmitter } from 'events';
 import WebSocket from 'isomorphic-ws';
-import { WsChannelSubUnSubRequestArg, WSClientConfigurableOptions, WsDataEvent, WsEvent } from './types';
-import { DefaultLogger, WsStore } from './util';
-import { WsKey } from './util/websocket-util';
-export type WsClientEvent = 'open' | 'update' | 'close' | 'error' | 'reconnect' | 'reconnected' | 'response';
-type WsKeyObject = {
-    wsKey: WsKey;
-};
-interface WebsocketClientEvents {
-    /** Connection opened. If this connection was previously opened and reconnected, expect the reconnected event instead */
-    open: (evt: {
-        event: any;
-    } & WsKeyObject) => void;
-    /** Reconnecting a dropped connection */
-    reconnect: (evt: {
-        event: any;
-    } & WsKeyObject) => void;
-    /** Successfully reconnected a connection that dropped */
-    reconnected: (evt: {
-        event: any;
-    } & WsKeyObject) => void;
-    /** Connection closed */
-    close: (evt: {
-        event: any;
-    } & WsKeyObject) => void;
-    /** Received reply to websocket command (e.g. after subscribing to topics or authenticating) */
-    response: (response: WsEvent & WsKeyObject) => void;
-    /** Received data for a topic/channel */
-    update: (response: WsDataEvent & WsKeyObject) => void;
-    /** Exception from ws client OR custom listeners */
-    error: (response: any) => void;
+import { WsDataEvent } from './types/websockets/ws-events.js';
+import { WSClientConfigurableOptions } from './types/websockets/ws-general.js';
+import { WsChannelSubUnSubRequestArg } from './types/websockets/ws-request.js';
+import { WSClientEventMap } from './util/BaseWSClient.js';
+import { DefaultLogger } from './util/logger.js';
+import { WsKey } from './util/websocket-util.js';
+import WsStore from './util/WsStore.js';
+export declare interface WebsocketClientLegacy {
+    on<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(event: U, listener: WSClientEventMap<WsKey>[U]): this;
+    emit<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(event: U, ...args: Parameters<WSClientEventMap<WsKey>[U]>): boolean;
 }
-export declare interface WebsocketClient {
-    on<U extends keyof WebsocketClientEvents>(event: U, listener: WebsocketClientEvents[U]): this;
-    emit<U extends keyof WebsocketClientEvents>(event: U, ...args: Parameters<WebsocketClientEvents[U]>): boolean;
-}
-export declare class WebsocketClient extends EventEmitter {
+/**
+ * @deprecated This is the old WebsocketClient that was part of the SDK prior to the V3 release. This legacy WebsocketClient is temporarily included but will be removed with the next major release.
+ */
+export declare class WebsocketClientLegacy extends EventEmitter {
     private logger;
     private options;
     private wsStore;
-    constructor(options: WSClientConfigurableOptions, logger?: typeof DefaultLogger);
+    constructor(options: WSClientConfigurableOptions, logger?: DefaultLogger);
     /**
      * Subscribe to topics & track/persist them. They will be automatically resubscribed to if the connection drops/reconnects.
      * @param wsEvents topic or list of topics
@@ -53,7 +32,7 @@ export declare class WebsocketClient extends EventEmitter {
      */
     unsubscribe(wsTopics: WsChannelSubUnSubRequestArg[] | WsChannelSubUnSubRequestArg, isPrivateTopic?: boolean): void;
     /** Get the WsStore that tracks websocket & topic state */
-    getWsStore(): WsStore<WsChannelSubUnSubRequestArg>;
+    getWsStore(): WsStore<WsKey, WsChannelSubUnSubRequestArg>;
     close(wsKey: WsKey, force?: boolean): void;
     closeAll(force?: boolean): void;
     /**
@@ -95,4 +74,3 @@ export declare class WebsocketClient extends EventEmitter {
     private onWsMessage;
     private onWsClose;
 }
-export {};