okx-api 2.0.6 → 3.0.0-beta.0

package/dist/cjs/types/websockets/ws-api.d.ts

@@ -0,0 +1,139 @@
+import { WS_KEY_MAP, WsKey } from '../../util/websocket-util.js';
+import { OrderIdRequest } from '../rest/request/trade.js';
+import { OrderResult } from '../rest/response/private-trade.js';
+import { numberInString } from '../rest/shared.js';
+import { WSAPIAmendOrderRequestV5, WSAPIAmendSpreadOrderRequestV5, WSAPICancelSpreadOrderRequestV5, WSAPIMassCancelOrdersRequestV5, WSAPIPlaceOrderRequestV5, WSAPIPlaceSpreadOrderRequestV5, WSAPISpreadMassCancelOrdersRequestV5 } from './ws-api-request.js';
+import { WSAPICancelOrderResultV5, WSAPISpreadAmendOrderResultV5, WSAPISpreadCancelOrderResultV5, WSAPISpreadPlaceOrderResultV5 } from './ws-api-response.js';
+import { WsAuthRequestArg, WsChannelSubUnSubRequestArg } from './ws-request.js';
+export interface WSAPIRequestFlags {
+    /** If true, will skip auth requirement for WS API connection */
+    authIsOptional?: boolean | undefined;
+    /**
+     * Request effective deadline. Unix timestamp format in milliseconds, e.g. 1597026383085
+     *
+     * Only applies for order placement and order amend (batch commands included)
+     */
+    expTime?: numberInString;
+}
+export type WSOperation = 'subscribe' | 'unsubscribe' | 'login';
+/**
+ *
+ * Top level requests with args
+ *
+ */
+/**
+
+/**
+ * request looks like this:
+{
+  "id": "1512",
+  "op": "subscribe",
+  "args": [
+    {
+      "channel": "tickers",
+      "instId": "BTC-USDT"
+    }
+  ]
+}
+ */
+export interface WsRequestOperationOKX<TWSRequestArg> {
+    id: string;
+    op: WSOperation;
+    args?: TWSRequestArg[];
+}
+export interface WsSubRequest extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
+    op: 'subscribe';
+}
+export interface WsUnsubRequest extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
+    op: 'unsubscribe';
+}
+export interface WsAuthRequest extends WsRequestOperationOKX<WsAuthRequestArg> {
+    op: 'login';
+}
+export type WSAPIPrivateOperations = 'order' | 'batch-orders' | 'cancel-order' | 'batch-cancel-orders' | 'amend-order' | 'batch-amend-orders' | 'mass-cancel';
+export type WSAPIBusinessOperations = 'sprd-order' | 'sprd-amend-order' | 'sprd-cancel-order' | 'sprd-mass-cancel';
+export type WSAPIOperation = WSAPIPrivateOperations | WSAPIBusinessOperations;
+export declare const WS_API_Operations: WSAPIOperation[];
+export declare const WS_API_PRIVATE_OPERATIONS: WSAPIPrivateOperations[];
+export declare const WS_API_BUSINESS_OPERATIONS: WSAPIBusinessOperations[];
+export declare const WS_API_TAG_OPERATIONS: WSAPIOperation[];
+export interface WSAPIRequestOKX<TRequestParams> {
+    id: numberInString;
+    op: WSAPIOperation;
+    expTime?: numberInString;
+    args: TRequestParams[];
+}
+export interface WSAPIResponse<TResponseData extends object = object, TOperation extends WSAPIOperation = WSAPIOperation> {
+    wsKey: WsKey;
+    id: numberInString;
+    op: TOperation;
+    code: numberInString;
+    msg: string;
+    data: TResponseData[];
+    inTime: numberInString;
+    outTime: numberInString;
+}
+export interface WSOperationLoginParams {
+    apiKey: string;
+    passphrase: string;
+    timestamp: number;
+    sign: string;
+}
+export type Exact<T> = {
+    [K: string]: never;
+} & {
+    [K in keyof T]: T[K];
+};
+/**
+ * List of operations supported for this WsKey (connection)
+ */
+export interface WsAPIWsKeyTopicMap {
+    [WS_KEY_MAP.prodPrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.prodDemoPrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.prodBusiness]: WSAPIBusinessOperations;
+    [WS_KEY_MAP.prodDemoBusiness]: WSAPIBusinessOperations;
+    [WS_KEY_MAP.eeaLivePrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.eeaDemoPrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.usLivePrivate]: WSAPIPrivateOperations;
+    [WS_KEY_MAP.usDemoPrivate]: WSAPIPrivateOperations;
+}
+/**
+ * Request parameters expected per operation
+ */
+export interface WsAPITopicRequestParamMap {
+    order: WSAPIPlaceOrderRequestV5;
+    'batch-orders': WSAPIPlaceOrderRequestV5[];
+    'cancel-order': OrderIdRequest;
+    'batch-cancel-orders': OrderIdRequest[];
+    'amend-order': WSAPIAmendOrderRequestV5;
+    'batch-amend-orders': WSAPIAmendOrderRequestV5[];
+    'mass-cancel': WSAPIMassCancelOrdersRequestV5;
+    'sprd-order': WSAPIPlaceSpreadOrderRequestV5;
+    'sprd-amend-order': WSAPIAmendSpreadOrderRequestV5;
+    'sprd-cancel-order': WSAPICancelSpreadOrderRequestV5;
+    'sprd-mass-cancel': WSAPISpreadMassCancelOrdersRequestV5;
+}
+/**
+ * Response structure expected for each operation
+ */
+export interface WsAPIOperationResponseMap {
+    order: WSAPIResponse<[OrderResult], 'order'>;
+    'batch-orders': WSAPIResponse<OrderResult[], 'batch-orders'>;
+    'cancel-order': WSAPIResponse<[WSAPICancelOrderResultV5], 'cancel-order'>;
+    'batch-cancel-orders': WSAPIResponse<WSAPICancelOrderResultV5[], 'batch-cancel-orders'>;
+    'amend-order': WSAPIResponse<[OrderResult], 'amend-order'>;
+    'batch-amend-orders': WSAPIResponse<[OrderResult], 'batch-amend-orders'>;
+    'mass-cancel': WSAPIResponse<[{
+        result: boolean;
+    }], 'mass-cancel'>;
+    'sprd-order': WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], 'sprd-order'>;
+    'sprd-amend-order': WSAPIResponse<[
+        WSAPISpreadAmendOrderResultV5
+    ], 'sprd-amend-order'>;
+    'sprd-cancel-order': WSAPIResponse<[
+        WSAPISpreadCancelOrderResultV5
+    ], 'sprd-cancel-order'>;
+    'sprd-mass-cancel': WSAPIResponse<[{
+        result: boolean;
+    }], 'sprd-mass-cancel'>;
+}

package/dist/cjs/types/websockets/ws-api.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_API_TAG_OPERATIONS = exports.WS_API_BUSINESS_OPERATIONS = exports.WS_API_PRIVATE_OPERATIONS = exports.WS_API_Operations = void 0;
+const websocket_util_js_1 = require("../../util/websocket-util.js");
+exports.WS_API_Operations = [
+    'order',
+    'batch-orders',
+    'cancel-order',
+    'batch-cancel-orders',
+    'amend-order',
+    'batch-amend-orders',
+    'mass-cancel',
+    'sprd-order',
+    'sprd-amend-order',
+    'sprd-cancel-order',
+    'sprd-mass-cancel',
+];
+exports.WS_API_PRIVATE_OPERATIONS = [
+    'order',
+    'batch-orders',
+    'cancel-order',
+    'batch-cancel-orders',
+    'amend-order',
+    'batch-amend-orders',
+    'mass-cancel',
+];
+exports.WS_API_BUSINESS_OPERATIONS = [
+    'sprd-order',
+    'sprd-amend-order',
+    'sprd-cancel-order',
+    'sprd-mass-cancel',
+];
+exports.WS_API_TAG_OPERATIONS = [
+    'order',
+    'batch-orders',
+    'sprd-order',
+];
+//# sourceMappingURL=ws-api.js.map

package/dist/cjs/types/websockets/ws-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-api.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-api.ts"],"names":[],"mappings":";;;AAAA,oEAAiE;AAwGpD,QAAA,iBAAiB,GAAqB;IACjD,OAAO;IACP,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,aAAa;IACb,oBAAoB;IACpB,aAAa;IACb,YAAY;IACZ,kBAAkB;IAClB,mBAAmB;IACnB,kBAAkB;CACnB,CAAC;AAEW,QAAA,yBAAyB,GAA6B;IACjE,OAAO;IACP,cAAc;IACd,cAAc;IACd,qBAAqB;IACrB,aAAa;IACb,oBAAoB;IACpB,aAAa;CACd,CAAC;AAEW,QAAA,0BAA0B,GAA8B;IACnE,YAAY;IACZ,kBAAkB;IAClB,mBAAmB;IACnB,kBAAkB;CACnB,CAAC;AAEW,QAAA,qBAAqB,GAAqB;IACrD,OAAO;IACP,cAAc;IACd,YAAY;CACb,CAAC"}

package/{lib/types/websockets/event.d.ts → dist/cjs/types/websockets/ws-events.d.ts}

@@ -1,4 +1,10 @@
-import { WsChannel } from './request';
+import { WsChannel } from './ws-request.js';
+export interface MessageEventLike {
+    target: WebSocket;
+    type: 'message';
+    data: string;
+}
+export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;
 export interface WsEvent {
     event: 'error' | 'login' | 'subscribe' | 'unsubscribe' | 'channel-conn-count';
     code?: string;

package/dist/cjs/types/websockets/ws-events.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMessageEvent = isMessageEvent;
+function isMessageEvent(msg) {
+    if (typeof msg !== 'object' || !msg) {
+        return false;
+    }
+    const message = msg;
+    return message['type'] === 'message' && typeof message['data'] === 'string';
+}
+//# sourceMappingURL=ws-events.js.map

package/dist/cjs/types/websockets/ws-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-events.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-events.ts"],"names":[],"mappings":";;AAQA,wCAOC;AAPD,SAAgB,cAAc,CAAC,GAAY;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,GAAuB,CAAC;IACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC;AAC9E,CAAC"}

package/dist/cjs/types/websockets/ws-general.d.ts

@@ -0,0 +1,48 @@
+import { RestClientOptions } from '../rest/client.js';
+import { APICredentials, APIMarket } from '../shared.js';
+export interface WSClientConfigurableOptions {
+    accounts?: APICredentials[];
+    /**
+     * The API group this client should connect to:
+     * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
+     * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
+     * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
+     */
+    market?: APIMarket;
+    /**
+     * Set to `true` to use OKX's demo trading functionality
+     */
+    demoTrading?: boolean;
+    disableHeartbeat?: boolean;
+    /** How often to check if the connection is alive */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    requestOptions?: RestClientOptions;
+    wsOptions?: {
+        protocols?: string[];
+        agent?: any;
+    };
+    wsUrl?: string;
+    /**
+     * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
+     *
+     * Look in the examples folder for a demonstration on using node's createHmac instead.
+     */
+    customSignMessageFn?: (message: string, secret: string) => Promise<string>;
+}
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    market: APIMarket;
+    pongTimeout: number;
+    pingInterval: number;
+    reconnectTimeout: number;
+    authPrivateConnectionsOnConnect: boolean;
+    authPrivateRequests: boolean;
+    /**
+     * Whether to use native WebSocket ping/pong frames for heartbeats
+     */
+    useNativeHeartbeats: boolean;
+}
+export type WsEventInternalSrc = 'event' | 'function';

package/dist/cjs/types/websockets/ws-general.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ws-general.js.map

package/dist/cjs/types/websockets/ws-general.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-general.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-general.ts"],"names":[],"mappings":""}

package/{lib/types/websockets/request.d.ts → dist/cjs/types/websockets/ws-request.d.ts}

@@ -5,7 +5,6 @@ export interface WsAuthRequestArg {
     sign: string;
 }
 export type WsTradeOp = 'order' | 'batch-orders' | 'cancel-order' | 'batch-cancel-orders' | 'amend-order' | 'batch-amend-order';
-export type WsRequestOp = 'login' | 'subscribe' | 'unsubscribe';
 export type WsPrivateChannel = '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';
 export type WsPublicKlineChannel = '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';
 export type WsPublicMarkPriceKlineChannel = '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';
@@ -16,10 +15,6 @@ export type WsBusinessPrivateChannel = 'orders-algo' | 'algo-advance' | 'deposit
 export type WsBusinessPublicChannel = WsPublicKlineChannel | WsPublicMarkPriceKlineChannel | WsPublicIndexKlineChannel;
 export type WsBusinessChannel = WsBusinessPrivateChannel | WsBusinessPublicChannel;
 export type WsChannel = WsPublicChannel | WsPrivateChannel | WsBusinessChannel;
-export interface WsBaseRequest {
-    op: WsRequestOp;
-    args: any[];
-}
 /** Used to trigger order actions over websockets (e.g. placing & cancelling orders) */
 export interface WsTradeBaseRequest {
     op: WsTradeOp;
@@ -96,20 +91,3 @@ export interface WsPublicChannelArgLiquidationOrders extends WsBaseRequestArg {
     instType: 'SWAP' | 'FUTURES';
 }
 export type WsChannelSubUnSubRequestArg = WsPrivateChannelArgTickers | WsPrivateChannelArgWithCcy | WsPrivateChannelArgWithInstFamily | WsPrivateChannelArgAlgo | WsPrivateChannelArgBalanceAndPosition | WsPrivateChannelArgGridOrders | WsPrivateChannelArgGridOther | WsPublicChannelArgInstType | WsPublicChannelArgInstId | WsPublicChannelArgInstIdOrFamily | WsPublicChannelArgOptionSummary | WsPublicChannelArgStatus | WsPublicChannelArgLiquidationOrders;
-/**
- *
- * Top level requests with args
- *
- */
-export interface WsSubRequest extends WsBaseRequest {
-    op: 'subscribe';
-    args: WsChannelSubUnSubRequestArg[];
-}
-export interface WsUnsubRequest extends WsBaseRequest {
-    op: 'unsubscribe';
-    args: WsChannelSubUnSubRequestArg[];
-}
-export interface WsAuthRequest extends WsBaseRequest {
-    op: 'login';
-    args: WsAuthRequestArg[];
-}

package/dist/cjs/types/websockets/ws-request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ws-request.js.map

package/dist/cjs/types/websockets/ws-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-request.js","sourceRoot":"","sources":["../../../../src/types/websockets/ws-request.ts"],"names":[],"mappings":""}

package/{lib → dist/cjs}/util/BaseRestClient.d.ts

@@ -1,5 +1,5 @@
 import { AxiosRequestConfig } from 'axios';
-import { RestClientOptions } from '../types';
+import { RestClientOptions } from '../types/rest/client.js';
 export declare const MISSING_CREDENTIALS_ERROR = "Private endpoints require api and secret to be provided in the REST client constructor";
 export default abstract class BaseRestClient {
     private options;

package/dist/cjs/util/BaseRestClient.js

@@ -0,0 +1,237 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MISSING_CREDENTIALS_ERROR = void 0;
+const axios_1 = __importDefault(require("axios"));
+const https_1 = require("https");
+const requestUtils_js_1 = require("./requestUtils.js");
+const typeGuards_js_1 = require("./typeGuards.js");
+const webCryptoAPI_js_1 = require("./webCryptoAPI.js");
+// axios.interceptors.request.use((request) => {
+//   console.log(new Date(), 'Starting Request', JSON.stringify(request, null, 2));
+//   return request;
+// });
+// axios.interceptors.response.use((response) => {
+//   // console.log(new Date(), 'Response:', JSON.stringify(response, null, 2));
+//   console.log(
+//     new Date(),
+//     'Response:',
+//     JSON.stringify(
+//       {
+//         data: response.data,
+//         headers: response.headers,
+//       },
+//       null,
+//       2,
+//     ),
+//   );
+//   return response;
+// });
+exports.MISSING_CREDENTIALS_ERROR = 'Private endpoints require api and secret to be provided in the REST client constructor';
+class BaseRestClient {
+    options;
+    baseUrl;
+    globalRequestOptions;
+    apiKey;
+    apiSecret;
+    apiPassphrase;
+    constructor(options = {}, requestOptions = {}) {
+        // this.environment = environment;
+        this.options = {
+            // if true, we'll throw errors if any params are undefined
+            strict_param_validation: false,
+            market: 'prod',
+            ...options,
+        };
+        this.baseUrl = (0, requestUtils_js_1.getRestBaseUrl)(options.market || 'prod', options);
+        const hasOneCredential = options.apiKey || options.apiSecret || options.apiPass;
+        const hasAllCredentials = !!options.apiKey && !!options.apiSecret && !!options.apiPass;
+        // Allow empty object
+        if (hasOneCredential && !hasAllCredentials) {
+            throw new Error('API Key, Secret AND Passphrase are ALL required for private enpoints');
+        }
+        if (hasAllCredentials && !this.options.customSignMessageFn) {
+            // Provide a user friendly error message if the user is using an outdated Node.js version (where Web Crypto API is not available).
+            // A few users have been caught out by using the end-of-life Node.js v18 release.
+            (0, webCryptoAPI_js_1.checkWebCryptoAPISupported)();
+        }
+        this.globalRequestOptions = {
+            // in ms == 5 minutes by default
+            timeout: 1000 * 60 * 5,
+            // custom request options based on axios specs - see: https://github.com/axios/axios#request-config
+            ...requestOptions,
+        };
+        if (!this.globalRequestOptions.headers) {
+            this.globalRequestOptions.headers = {};
+        }
+        if (options.market === 'demo') {
+            throw new Error('ERROR: to use demo trading, set the "demoTrading: true" flag in the constructor');
+        }
+        //  Note: `x-simulated-trading: 1` needs to be added to the header of the Demo Trading request.
+        if (options.demoTrading) {
+            this.globalRequestOptions.headers['x-simulated-trading'] = 1;
+        }
+        this.globalRequestOptions.headers['Content-Type'] = 'application/json';
+        this.globalRequestOptions.headers['Accept'] = 'application/json';
+        // If enabled, configure a https agent with keepAlive enabled
+        if (this.options.keepAlive) {
+            // Extract existing https agent parameters, if provided, to prevent the keepAlive flag from overwriting an existing https agent completely
+            const existingHttpsAgent = this.globalRequestOptions.httpsAgent;
+            const existingAgentOptions = existingHttpsAgent?.options || {};
+            // For more advanced configuration, raise an issue on GitHub or use the "requestOptions"
+            // parameter to define a custom httpsAgent with the desired properties
+            this.globalRequestOptions.httpsAgent = new https_1.Agent({
+                ...existingAgentOptions,
+                keepAlive: true,
+                keepAliveMsecs: this.options.keepAliveMsecs,
+            });
+        }
+        this.apiKey = options?.apiKey;
+        this.apiSecret = options?.apiSecret;
+        this.apiPassphrase = options?.apiPass;
+    }
+    get(endpoint, params) {
+        return this._call('GET', endpoint, params, true);
+    }
+    post(endpoint, params) {
+        return this._call('POST', endpoint, params, true);
+    }
+    getPrivate(endpoint, params) {
+        return this._call('GET', endpoint, params, false);
+    }
+    postPrivate(endpoint, params) {
+        return this._call('POST', endpoint, Array.isArray(params)
+            ? params.map((p) => ({ ...p, [requestUtils_js_1.programKey]: requestUtils_js_1.programId }))
+            : { ...params, [requestUtils_js_1.programKey]: requestUtils_js_1.programId }, false);
+    }
+    deletePrivate(endpoint, params) {
+        return this._call('DELETE', endpoint, params, false);
+    }
+    /**
+     * Make a HTTP request to a specific endpoint. Private endpoints are automatically signed.
+     */
+    async _call(method, endpoint, params, isPublicApi) {
+        const options = {
+            ...this.globalRequestOptions,
+            url: [this.baseUrl, endpoint].join(endpoint.startsWith('/') ? '' : '/'),
+            method: method,
+            json: true,
+        };
+        // Delete any params without value
+        if (params) {
+            for (const key in params) {
+                if (typeof params[key] === 'undefined') {
+                    delete params[key];
+                }
+            }
+        }
+        const tsISO = new Date().toISOString();
+        const signResult = await this.signRequest(isPublicApi, tsISO, method, endpoint, params);
+        if (!options.headers) {
+            options.headers = {};
+        }
+        if (!isPublicApi) {
+            options.headers['OK-ACCESS-KEY'] = this.apiKey;
+            options.headers['OK-ACCESS-SIGN'] = signResult.sign;
+            options.headers['OK-ACCESS-TIMESTAMP'] = tsISO;
+            options.headers['OK-ACCESS-PASSPHRASE'] = this.apiPassphrase;
+        }
+        if (method === 'GET') {
+            options.params = signResult.requestBody;
+        }
+        else {
+            options.data = signResult.requestBody;
+        }
+        // console.log(new Date(), 'request: ', {
+        // url: options.url,
+        // method,
+        // params: signResult.requestBody,
+        // sign: signResult.sign,
+        //   options,
+        // });
+        return (0, axios_1.default)(options)
+            .then((response) => {
+            // Check this is an API response without an error code.
+            // If so, resolve the nested data property, else throw the full response body
+            if ((0, typeGuards_js_1.isRawAPIResponse)(response.data) &&
+                response.status == 200 &&
+                response.data?.code === '0') {
+                return response.data.data;
+            }
+            // console.log('request: ', JSON.stringify(options, null, 2));
+            // console.log(
+            //   'bad response: ',
+            //   JSON.stringify(
+            //     {
+            //       data: response.data,
+            //       headers: response.headers,
+            //     },
+            //     null,
+            //     2
+            //   )
+            // );
+            // Also throw if API returned error code
+            // This API error thrown by the exchange will be post-processed by the exception parser
+            throw { response };
+        })
+            .catch((e) => this.parseException(e));
+    }
+    /**
+     * Sign request
+     */
+    async signRequest(isPublicApi, tsISO, method, endpoint, params) {
+        const res = {
+            requestBody: params,
+            method,
+            endpoint,
+            sign: '',
+        };
+        if (isPublicApi) {
+            return res;
+        }
+        if (!this.apiKey || !this.apiSecret || !this.apiPassphrase) {
+            throw new Error(exports.MISSING_CREDENTIALS_ERROR);
+        }
+        const serializedParams = (0, requestUtils_js_1.serializeParams)(params, method, this.options.strict_param_validation);
+        const message = tsISO + method + endpoint + serializedParams;
+        // console.log(new Date(), `Sign params: `, {
+        //   message,
+        //   secret: this.apiSecret,
+        // });
+        return {
+            ...res,
+            sign: await (0, webCryptoAPI_js_1.signMessage)(message, this.apiSecret, 'base64', 'SHA-256'),
+        };
+    }
+    /**
+     * Generic handler to parse request exceptions
+     */
+    parseException(e) {
+        if (this.options.parse_exceptions === 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;
+        throw response.data;
+        // throw {
+        //   status: response.status,
+        //   statusText: response.statusText,
+        //   data: response.data,
+        //   headers: response.headers,
+        //   requestOptions: this.options,
+        // };
+    }
+}
+exports.default = BaseRestClient;
+//# sourceMappingURL=BaseRestClient.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyE;AACzE,iCAA8B;AAI9B,uDAK2B;AAC3B,mDAAmD;AACnD,uDAA4E;AAE5E,gDAAgD;AAChD,mFAAmF;AACnF,oBAAoB;AACpB,MAAM;AAEN,kDAAkD;AAClD,gFAAgF;AAChF,iBAAiB;AACjB,kBAAkB;AAClB,mBAAmB;AACnB,sBAAsB;AACtB,UAAU;AACV,+BAA+B;AAC/B,qCAAqC;AACrC,WAAW;AACX,cAAc;AACd,WAAW;AACX,SAAS;AACT,OAAO;AACP,qBAAqB;AACrB,MAAM;AAEO,QAAA,yBAAyB,GACpC,wFAAwF,CAAC;AAS3F,MAA8B,cAAc;IAClC,OAAO,CAAoB;IAE3B,OAAO,CAAS;IAEhB,oBAAoB,CAAqB;IAEzC,MAAM,CAAqB;IAE3B,SAAS,CAAqB;IAE9B,aAAa,CAAqB;IAE1C,YACE,UAA6B,EAAE,EAC/B,iBAAqC,EAAE;QAEvC,kCAAkC;QAElC,IAAI,CAAC,OAAO,GAAG;YACb,0DAA0D;YAC1D,uBAAuB,EAAE,KAAK;YAC9B,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,IAAA,gCAAc,EAAC,OAAO,CAAC,MAAM,IAAI,MAAM,EAAE,OAAO,CAAC,CAAC;QAEjE,MAAM,gBAAgB,GACpB,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;QACzD,MAAM,iBAAiB,GACrB,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAE/D,qBAAqB;QACrB,IAAI,gBAAgB,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;QACJ,CAAC;QAED,IAAI,iBAAiB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;YAC3D,kIAAkI;YAClI,iFAAiF;YACjF,IAAA,4CAA0B,GAAE,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,oBAAoB,GAAG;YAC1B,gCAAgC;YAChC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC;YACtB,mGAAmG;YACnG,GAAG,cAAc;SAClB,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC,oBAAoB,CAAC,OAAO,GAAG,EAAE,CAAC;QACzC,CAAC;QAED,IAAK,OAAO,CAAC,MAAc,KAAK,MAAM,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;QACJ,CAAC;QAED,+FAA+F;QAC/F,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACvE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC;QAEjE,6DAA6D;QAC7D,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC3B,0IAA0I;YAC1I,MAAM,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAExC,CAAC;YACd,MAAM,oBAAoB,GAAG,kBAAkB,EAAE,OAAO,IAAI,EAAE,CAAC;YAE/D,wFAAwF;YACxF,sEAAsE;YACtE,IAAI,CAAC,oBAAoB,CAAC,UAAU,GAAG,IAAI,aAAK,CAAC;gBAC/C,GAAG,oBAAoB;gBACvB,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc;aAC5C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,OAAO,EAAE,OAAO,CAAC;IACxC,CAAC;IAEM,GAAG,CAAC,QAAgB,EAAE,MAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,IAAI,CAAC,QAAgB,EAAE,MAAY;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAEM,UAAU,CAAC,QAAgB,EAAE,MAAY;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAEM,WAAW,CAAC,QAAgB,EAAE,MAAY;QAC/C,OAAO,IAAI,CAAC,KAAK,CACf,MAAM,EACN,QAAQ,EACR,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YACnB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,4BAAU,CAAC,EAAE,2BAAS,EAAE,CAAC,CAAC;YACxD,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,4BAAU,CAAC,EAAE,2BAAS,EAAE,EAC1C,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,aAAa,CAAC,QAAgB,EAAE,MAAY;QACjD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAA0B,EAC1B,WAAoB;QAEpB,MAAM,OAAO,GAAG;YACd,GAAG,IAAI,CAAC,oBAAoB;YAC5B,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YACvE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;SACX,CAAC;QAEF,kCAAkC;QAClC,IAAI,MAAM,EAAE,CAAC;YACX,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBACzB,IAAI,OAAQ,MAAc,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE,CAAC;oBAChD,OAAQ,MAAc,CAAC,GAAG,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CACvC,WAAW,EACX,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;YAC/C,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;YACpD,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC;YAC/C,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/D,CAAC;QAED,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC;QACxC,CAAC;QAED,yCAAyC;QACzC,oBAAoB;QACpB,UAAU;QACV,kCAAkC;QAClC,yBAAyB;QACzB,aAAa;QACb,MAAM;QAEN,OAAO,IAAA,eAAK,EAAC,OAAO,CAAC;aAClB,IAAI,CAAC,CAAC,QAA6C,EAAE,EAAE;YACtD,uDAAuD;YACvD,6EAA6E;YAC7E,IACE,IAAA,gCAAgB,EAAC,QAAQ,CAAC,IAAI,CAAC;gBAC/B,QAAQ,CAAC,MAAM,IAAI,GAAG;gBACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,GAAG,EAC3B,CAAC;gBACD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,CAAC;YAED,8DAA8D;YAC9D,eAAe;YACf,sBAAsB;YACtB,oBAAoB;YACpB,QAAQ;YACR,6BAA6B;YAC7B,mCAAmC;YACnC,SAAS;YACT,YAAY;YACZ,QAAQ;YACR,MAAM;YACN,KAAK;YAEL,wCAAwC;YACxC,uFAAuF;YACvF,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,WAAW,CACvB,WAAoB,EACpB,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,MAAqB;QAErB,MAAM,GAAG,GAAqB;YAC5B,WAAW,EAAE,MAAM;YACnB,MAAM;YACN,QAAQ;YACR,IAAI,EAAE,EAAE;SACT,CAAC;QAEF,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,GAAG,CAAC;QACb,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,iCAAyB,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAA,iCAAe,EACtC,MAAM,EACN,MAAM,EACN,IAAI,CAAC,OAAO,CAAC,uBAAuB,CACrC,CAAC;QAEF,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,CAAC;QAC7D,6CAA6C;QAC7C,aAAa;QACb,4BAA4B;QAC5B,MAAM;QAEN,OAAO;YACL,GAAG,GAAG;YACN,IAAI,EAAE,MAAM,IAAA,6BAAW,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC;SACtE,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,CAAM;QAC3B,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;YAC5C,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,MAAM,QAAQ,CAAC,IAAI,CAAC;QACpB,UAAU;QACV,6BAA6B;QAC7B,qCAAqC;QACrC,yBAAyB;QACzB,+BAA+B;QAC/B,kCAAkC;QAClC,KAAK;IACP,CAAC;CACF;AA5RD,iCA4RC"}