okx-api 0.0.1 → 0.0.2

package/lib/util/BaseRestClient.js

@@ -0,0 +1,204 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 node_support_1 = require("./node-support");
+const requestUtils_1 = require("./requestUtils");
+const typeGuards_1 = require("./typeGuards");
+// 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 {
+    constructor(credentials, baseUrl, options = {}, requestOptions = {}, environment) {
+        this.environment = environment;
+        this.options = Object.assign({ 
+            // if true, we'll throw errors if any params are undefined
+            strict_param_validation: false }, options);
+        this.baseUrl = baseUrl;
+        // Allow empty object
+        if (credentials &&
+            (!credentials.apiKey ||
+                !credentials.apiSecret ||
+                !credentials.apiPassphrase)) {
+            throw new Error('API Key, Secret AND Passphrase are ALL required for private enpoints');
+        }
+        this.globalRequestOptions = Object.assign({ 
+            // in ms == 5 minutes by default
+            timeout: 1000 * 60 * 5, headers: {} }, requestOptions);
+        //  Note: `x-simulated-trading: 1` needs to be added to the header of the Demo Trading request.
+        if (environment === 'demo') {
+            this.globalRequestOptions.headers['x-simulated-trading'] = 1;
+        }
+        this.globalRequestOptions.headers['Content-Type'] = 'application/json';
+        this.globalRequestOptions.headers['Accept'] = 'application/json';
+        this.apiKey = credentials === null || credentials === void 0 ? void 0 : credentials.apiKey;
+        this.apiSecret = credentials === null || credentials === void 0 ? void 0 : credentials.apiSecret;
+        this.apiPassphrase = credentials === null || credentials === void 0 ? void 0 : credentials.apiPassphrase;
+    }
+    // private isDemoTrading(): boolean {
+    //   return this.environment === 'demo';
+    // }
+    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) => (Object.assign(Object.assign({}, p), { [requestUtils_1.programKey]: requestUtils_1.programId })))
+            : Object.assign(Object.assign({}, params), { [requestUtils_1.programKey]: requestUtils_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.
+     */
+    _call(method, endpoint, params, isPublicApi) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = Object.assign(Object.assign({}, this.globalRequestOptions), { url: [this.baseUrl, endpoint].join(endpoint.startsWith('/') ? '' : '/'), method: method, json: true });
+            // Delete any params without value
+            for (const key in params) {
+                if (typeof params[key] === 'undefined') {
+                    delete params[key];
+                }
+            }
+            const tsISO = new Date().toISOString();
+            const signResult = yield this.signRequest(isPublicApi, tsISO, method, endpoint, params);
+            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,
+            // });
+            return (0, axios_1.default)(options)
+                .then((response) => {
+                var _a;
+                // 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_1.isRawAPIResponse)(response.data) &&
+                    response.status == 200 &&
+                    ((_a = response.data) === null || _a === void 0 ? void 0 : _a.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
+     */
+    signRequest(isPublicApi, tsISO, method, endpoint, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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_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 Object.assign(Object.assign({}, res), { sign: (0, node_support_1.signMessage)(message, this.apiSecret) });
+        });
+    }
+    /**
+     * 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/lib/util/BaseRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAAyE;AAEzE,iDAA6C;AAE7C,iDAMwB;AACxB,6CAAgD;AAEhD,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,UAAU;AACV,QAAQ;AACR,OAAO;AACP,qBAAqB;AACrB,MAAM;AAEO,QAAA,yBAAyB,GACpC,wFAAwF,CAAC;AAe3F,MAA8B,cAAc;IAU1C,YACE,WAA8C,EAC9C,OAAe,EACf,UAA6B,EAAE,EAC/B,iBAAqC,EAAE,EACvC,WAA2B;QAE3B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAE/B,IAAI,CAAC,OAAO;YACV,0DAA0D;YAC1D,uBAAuB,EAAE,KAAK,IAC3B,OAAO,CACX,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,qBAAqB;QACrB,IACE,WAAW;YACX,CAAC,CAAC,WAAW,CAAC,MAAM;gBAClB,CAAC,WAAW,CAAC,SAAS;gBACtB,CAAC,WAAW,CAAC,aAAa,CAAC,EAC7B;YACA,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;SACH;QAED,IAAI,CAAC,oBAAoB;YACvB,gCAAgC;YAChC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,EACtB,OAAO,EAAE,EAAE,IAER,cAAc,CAClB,CAAC;QAEF,+FAA+F;QAC/F,IAAI,WAAW,KAAK,MAAM,EAAE;YAC1B,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;SAC9D;QACD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACvE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC;QAEjE,IAAI,CAAC,MAAM,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,CAAC;IAClD,CAAC;IAED,qCAAqC;IACrC,wCAAwC;IACxC,IAAI;IAEG,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,iCAAM,CAAC,KAAE,CAAC,yBAAU,CAAC,EAAE,wBAAS,IAAG,CAAC;YACxD,CAAC,iCAAM,MAAM,KAAE,CAAC,yBAAU,CAAC,EAAE,wBAAS,GAAE,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;IACW,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAsB,EACtB,WAAoB;;YAEpB,MAAM,OAAO,mCACR,IAAI,CAAC,oBAAoB,KAC5B,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,EACvE,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,GACX,CAAC;YAEF,kCAAkC;YAClC,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;aACF;YAED,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CACvC,WAAW,EACX,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,CACP,CAAC;YAEF,IAAI,CAAC,WAAW,EAAE;gBAChB,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC/C,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;gBACpD,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,KAAK,CAAC;gBAC/C,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;aAC9D;YAED,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC;aACzC;iBAAM;gBACL,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC;aACvC;YAED,yCAAyC;YACzC,sBAAsB;YACtB,YAAY;YACZ,oCAAoC;YACpC,2BAA2B;YAC3B,MAAM;YAEN,OAAO,IAAA,eAAK,EAAC,OAAO,CAAC;iBAClB,IAAI,CAAC,CAAC,QAA6C,EAAE,EAAE;;gBACtD,uDAAuD;gBACvD,6EAA6E;gBAC7E,IACE,IAAA,6BAAgB,EAAC,QAAQ,CAAC,IAAI,CAAC;oBAC/B,QAAQ,CAAC,MAAM,IAAI,GAAG;oBACtB,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,MAAK,GAAG,EAC3B;oBACA,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC3B;gBAED,8DAA8D;gBAC9D,eAAe;gBACf,sBAAsB;gBACtB,oBAAoB;gBACpB,QAAQ;gBACR,6BAA6B;gBAC7B,mCAAmC;gBACnC,SAAS;gBACT,YAAY;gBACZ,QAAQ;gBACR,MAAM;gBACN,KAAK;gBAEL,wCAAwC;gBACxC,uFAAuF;gBACvF,MAAM,EAAE,QAAQ,EAAE,CAAC;YACrB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACW,WAAW,CACvB,WAAoB,EACpB,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,MAAqB;;YAErB,MAAM,GAAG,GAAqB;gBAC5B,WAAW,EAAE,MAAM;gBACnB,MAAM;gBACN,QAAQ;gBACR,IAAI,EAAE,EAAE;aACT,CAAC;YAEF,IAAI,WAAW,EAAE;gBACf,OAAO,GAAG,CAAC;aACZ;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,iCAAyB,CAAC,CAAC;aAC5C;YAED,MAAM,gBAAgB,GAAG,IAAA,8BAAe,EACtC,MAAM,EACN,MAAM,EACN,IAAI,CAAC,OAAO,CAAC,uBAAuB,CACrC,CAAC;YAEF,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,CAAC;YAC7D,6CAA6C;YAC7C,aAAa;YACb,4BAA4B;YAC5B,MAAM;YAEN,uCACK,GAAG,KACN,IAAI,EAAE,IAAA,0BAAW,EAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAC1C;QACJ,CAAC;KAAA;IAED;;OAEG;IACK,cAAc,CAAC,CAAM;QAC3B,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,KAAK,EAAE;YAC3C,MAAM,CAAC,CAAC;SACT;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,MAAM,CAAC,CAAC,OAAO,CAAC;aACjB;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;SACT;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;AAvPD,iCAuPC"}

package/lib/util/browser-support.d.ts

@@ -0,0 +1 @@
+export declare function signMessage(message: string, secret: string): Promise<string>;

package/lib/util/browser-support.js

@@ -0,0 +1,24 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signMessage = void 0;
+function signMessage(message, secret) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const encoder = new TextEncoder();
+        const key = yield window.crypto.subtle.importKey('raw', encoder.encode(secret), { name: 'HMAC', hash: { name: 'SHA-256' } }, false, ['sign']);
+        const signature = yield window.crypto.subtle.sign('HMAC', key, encoder.encode(message));
+        return Array.prototype.map
+            .call(new Uint8Array(signature), (x) => ('00' + x.toString(16)).slice(-2))
+            .join('');
+    });
+}
+exports.signMessage = signMessage;
+//# sourceMappingURL=browser-support.js.map

package/lib/util/browser-support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-support.js","sourceRoot":"","sources":["../../src/util/browser-support.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,SAAsB,WAAW,CAC/B,OAAe,EACf,MAAc;;QAEd,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAC9C,KAAK,EACL,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EACtB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAC3C,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAC/C,MAAM,EACN,GAAG,EACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CACxB,CAAC;QAEF,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG;aACvB,IAAI,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,CAAM,EAAE,EAAE,CAC1C,CAAC,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAClC;aACA,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,CAAC;CAAA;AAxBD,kCAwBC"}

package/lib/util/node-support.d.ts

@@ -0,0 +1 @@
+export declare function signMessage(message: string, secret: string): string;

package/lib/util/node-support.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signMessage = void 0;
+const crypto_1 = require("crypto");
+function signMessage(message, secret) {
+    return (0, crypto_1.createHmac)('sha256', secret).update(message).digest('base64');
+}
+exports.signMessage = signMessage;
+//# sourceMappingURL=node-support.js.map

package/lib/util/node-support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-support.js","sourceRoot":"","sources":["../../src/util/node-support.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AAEpC,SAAgB,WAAW,CAAC,OAAe,EAAE,MAAc;IACzD,OAAO,IAAA,mBAAU,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACvE,CAAC;AAFD,kCAEC"}

package/lib/util/requestUtils.d.ts

@@ -0,0 +1,17 @@
+import { Method } from 'axios';
+export interface RestClientOptions {
+    strict_param_validation?: boolean;
+    baseUrl?: string;
+    parse_exceptions?: boolean;
+}
+export declare function serializeParams(params: object | undefined, method: Method, strict_validation?: boolean): string;
+export declare const programKey = "tag";
+export declare const programId = "159881cb7207BCDE";
+/**
+ * - live: production,
+ * - aws: aws subdomain,
+ * - demo: demo environment
+ */
+export declare type OKXEnvironment = 'live' | 'aws' | 'demo';
+export declare function getRestBaseUrl(environment: OKXEnvironment, restClientOptions: RestClientOptions): string;
+export declare function isWsPong(response: any): any;

package/lib/util/requestUtils.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWsPong = exports.getRestBaseUrl = exports.programId = exports.programKey = exports.serializeParams = void 0;
+function serializeParams(params, method, strict_validation = false) {
+    if (!params) {
+        return '';
+    }
+    if (method !== 'GET') {
+        return JSON.stringify(params);
+    }
+    // Original order should be preserved, no sorting allowed here or sign will fail
+    return ('?' +
+        Object.keys(params)
+            .map((key) => {
+            const value = params[key];
+            if (strict_validation === true && typeof value === 'undefined') {
+                throw new Error('Failed to sign API request due to undefined parameter');
+            }
+            return `${key}=${value}`;
+        })
+            .join('&'));
+}
+exports.serializeParams = serializeParams;
+exports.programKey = 'tag';
+exports.programId = '159881cb7207BCDE';
+function getRestBaseUrl(environment, restClientOptions) {
+    if (restClientOptions.baseUrl) {
+        return restClientOptions.baseUrl;
+    }
+    switch (environment) {
+        default:
+        case 'demo':
+        case 'live': {
+            return 'https://www.okx.com';
+        }
+        case 'aws': {
+            return 'https://aws.okex.com';
+        }
+    }
+}
+exports.getRestBaseUrl = getRestBaseUrl;
+function isWsPong(response) {
+    if (response.pong || response.ping) {
+        return true;
+    }
+    return (response.request &&
+        response.request.op === 'ping' &&
+        response.ret_msg === 'pong' &&
+        response.success === true);
+}
+exports.isWsPong = isWsPong;
+//# sourceMappingURL=requestUtils.js.map

package/lib/util/requestUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;AAcA,SAAgB,eAAe,CAC7B,MAA0B,EAC1B,MAAc,EACd,iBAAiB,GAAG,KAAK;IAEzB,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC;KACX;IAED,IAAI,MAAM,KAAK,KAAK,EAAE;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KAC/B;IAED,gFAAgF;IAChF,OAAO,CACL,GAAG;QACH,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aAChB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;gBAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;aACH;YACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;QAC3B,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,CAAC,CACb,CAAC;AACJ,CAAC;AA5BD,0CA4BC;AACY,QAAA,UAAU,GAAG,KAAK,CAAC;AACnB,QAAA,SAAS,GAAG,kBAAkB,CAAC;AAS5C,SAAgB,cAAc,CAC5B,WAA2B,EAC3B,iBAAoC;IAEpC,IAAI,iBAAiB,CAAC,OAAO,EAAE;QAC7B,OAAO,iBAAiB,CAAC,OAAO,CAAC;KAClC;IAED,QAAQ,WAAW,EAAE;QACnB,QAAQ;QACR,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC,CAAC;YACX,OAAO,qBAAqB,CAAC;SAC9B;QACD,KAAK,KAAK,CAAC,CAAC;YACV,OAAO,sBAAsB,CAAC;SAC/B;KACF;AACH,CAAC;AAlBD,wCAkBC;AAED,SAAgB,QAAQ,CAAC,QAAa;IACpC,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM;QAC9B,QAAQ,CAAC,OAAO,KAAK,MAAM;QAC3B,QAAQ,CAAC,OAAO,KAAK,IAAI,CAC1B,CAAC;AACJ,CAAC;AAVD,4BAUC"}

package/lib/util/typeGuards.d.ts

@@ -0,0 +1,2 @@
+import { APIResponse } from '../types/rest';
+export declare function isRawAPIResponse(response: unknown): response is APIResponse<unknown>;

package/lib/util/typeGuards.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRawAPIResponse = void 0;
+function isRawAPIResponse(response) {
+    if (typeof response !== 'object' || !response) {
+        return false;
+    }
+    if ('code' in response && 'msg' in response && 'data' in response) {
+        return true;
+    }
+    return false;
+}
+exports.isRawAPIResponse = isRawAPIResponse;
+//# sourceMappingURL=typeGuards.js.map

package/lib/util/typeGuards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../src/util/typeGuards.ts"],"names":[],"mappings":";;;AAEA,SAAgB,gBAAgB,CAC9B,QAAiB;IAEjB,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,EAAE;QAC7C,OAAO,KAAK,CAAC;KACd;IAED,IAAI,MAAM,IAAI,QAAQ,IAAI,KAAK,IAAI,QAAQ,IAAI,MAAM,IAAI,QAAQ,EAAE;QACjE,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAZD,4CAYC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "EARLY BETA. Node.js connector for OKX REST APIs and WebSockets, with TypeScript & integration tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -27,14 +27,14 @@
     "ws": "^7.4.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.23",
+    "@types/jest": "^28.1.4",
     "@types/node": "^14.14.7",
-    "eslint": "^7.10.0",
-    "jest": "^27.0.4",
-    "source-map-loader": "^2.0.0",
-    "ts-jest": "^27.0.3",
-    "ts-loader": "^8.0.11",
-    "typescript": "^4.0.5",
+    "eslint": "^8.19.0",
+    "jest": "^28.1.2",
+    "source-map-loader": "^4.0.0",
+    "ts-jest": "^28.0.5",
+    "ts-loader": "^9.3.1",
+    "typescript": "^4.7.4",
     "webpack": "^5.4.0",
     "webpack-bundle-analyzer": "^4.1.0",
     "webpack-cli": "^4.2.0"