asterdex 1.0.0

package/README.md

@@ -0,0 +1,77 @@
+# About
+
+A simple AsterDex.com api for REST api: https://github.com/asterdex/api-docs.
+
+## Usage example 1 (api class)
+
+```
+const api = require('asterdex')
+let ac = new api("<APIKEY>", "<SECRET>");
+async function f(){
+  let r = await ac.get('/fapi/v2/balance')
+  console.log(r)
+}
+f()
+```
+
+## Usage example 2 (call function)
+
+```
+const {call} = require('asterdex')
+let apiKey = "<APIKEY>";
+let secret = "<SECRET>";
+let path = "/fapi/v2/balance";
+async function f() {
+  let r = await call(path, { apiKey, secret, data, method, raw });
+  console.log(r);
+}
+f();
+```
+
+### Parameters 1 (api class)
+
+```
+let ac = new api("<APIKEY>", "<SECRET>", {testnet});
+ac.get(path, data, { raw }) // GET
+ac.post(path, data, { raw }) // POST
+ac.put(path, data, { raw }) // PUT
+ac.delete(path, data, { raw }) // DELETE
+ac.getPublic(path, data, { raw }) // GET public endpoint // alt: ac.call(path[, data])
+ac.call() // refer above
+```
+
+required: path: eg: "/fapi/v2/balance"
+optional:
+
+- apiKey, secret: can be omitted for public endpoint: eg: "/fapi/v1/exchangeInfo"
+- testnet: 0|1, default: 0
+- data: payload parameters object to be sent
+- raw: 0|1, default: 0, get the raw return with headers and status, else return only the data.
+
+### Parameters 2 (call function)
+
+```
+  call(path, { data, apiKey, secret, method, testnet, raw } = {})
+```
+
+required: path: eg: "/papi/v1/balance"
+optional:
+
+- data: payload parameters object to be sent
+- apiKey, secret: can be omitted for public endpoint: eg: "/fapi/v1/exchangeInfo"
+- method: "GET|POST", default: "GET"
+- testnet: 0|1, default: 0
+- raw: 0|1, default: 0, get the raw return with headers and status, else return only the data.
+
+### Global rate limit
+
+```
+global.bnbLimit["x-mbx-used-weight"]
+global.bnbLimit["x-mbx-used-weight-1m"]
+global.bnbLimit["x-mbx-order-count-10s"]
+global.bnbLimit["x-mbx-order-count-1m"]
+global.bnbLimit["x-sapi-used-ip-weight-1m"]
+global.bnbLimit["x-sapi-used-uid-weight-1m"]
+```
+
+Only used limit will be shown.

package/index.js

@@ -0,0 +1,157 @@
+const axios = require("axios");
+// const crypto = require("crypto");
+const hmacSHA256 = require("crypto-js/hmac-sha256");
+
+function getSig(data = {}, secret, timestamp = "") {
+  let dt = { ...data };
+  dt.timestamp ??= timestamp ?? Date.now();
+  let qs = new URLSearchParams(dt).toString();
+  qs = decodeURIComponent(qs); //convert %40 into @ //qs = qs.replace("/%40/g", "@");
+  return hmacSHA256(qs, secret).toString();
+  // return crypto.createHmac("sha256", secret).update(qs).digest("hex");
+}
+
+function getQs(data = {}, secret = "") {
+  let dt = secret ? { ...data, timestamp: Date.now() } : data;
+  const qs = new URLSearchParams(dt).toString();
+  return secret ? `?${qs}&signature=${getSig(dt, secret)}` : `?${qs}`;
+}
+
+function getUrl(path, testnet) {
+  let postFix = testnet ? "-testnet" : "";
+  if (path.match(/^\/api\//)) path = `https://api.asterdex${postFix}.com` + path;
+  else if (path.match(/^\/sapi\//)) path = `https://api.asterdex${postFix}.com` + path;
+  else if (path.match(/^\/papi\//)) path = `https://papi.asterdex${postFix}.com` + path;
+  else if (path.match(/^\/fapi\//)) path = `https://fapi.asterdex${postFix}.com` + path;
+  else if (path.match(/^\/dapi\//)) path = `https://dapi.asterdex${postFix}.com` + path;
+  return path;
+}
+
+let public = [
+  "/api/v3/aggTrades",
+  "/api/v3/avgPrice",
+  "/api/v3/depth",
+  "/api/v3/exchangeInfo",
+  "/api/v3/klines",
+  "/api/v3/ping",
+  "/api/v3/ticker",
+  "/api/v3/ticker/24hr",
+  "/api/v3/ticker/bookTicker",
+  "/api/v3/ticker/price",
+  "/api/v3/time",
+  "/api/v3/trades",
+  "/api/v3/uiKlines",
+];
+
+async function call(path, { data, apiKey, secret, method, testnet, raw } = {}) {
+  apiKey ??= "";
+  secret ??= "";
+  method ??= "GET";
+  testnet ??= 0;
+  raw ??= 0;
+  data ??= {};
+  data.recvWindow ??= 30000; // 60s 30s 15s 5s
+  let url = testnet ? getUrl(path, true) : getUrl(path);
+
+  let headers = { "X-MBX-APIKEY": apiKey };
+  if (["POST", "DELETE", "PUT"].includes(method)) {
+    headers["Content-Type"] = "application/x-www-form-urlencoded";
+    if (Object.keys(data).length > 0) {
+      let ts = Date.now();
+      data.timestamp = ts;
+      // data.recvWindow ??= 30000; // 60s 30s 15s 5s
+      if (data.signature) delete data.signature; // else same data object sent will have previous signature
+      data.signature = getSig(data, secret);
+    }
+  } else if (method == "PUT") {
+    headers["Content-Type"] = "application/x-www-form-urlencoded"; // old backup: maybe PUT cannot be signed for PUT /papi/v1/listenKey
+  } else {
+    if (public.includes(path)) delete data.recvWindow; // public no recvWindow
+    let qs = public.includes(path) ? getQs(data) : getQs(data, secret);
+    url += qs;
+    data = "";
+  }
+
+  let config = {
+    method,
+    url,
+    headers,
+    data,
+  };
+
+  let r = await axios(config)
+    .then((r) => {
+      let rs = r.data;
+      let types = [];
+      for (let type in { ...r.headers, ...(global.bnbLimit ?? {}) }) {
+        let r = type.match(/^[xX]-(?:mbx|sapi|papi|fapi|api).*$/); // match "x-"
+        if (r != null && !types.includes(r[0])) {
+          types.push(r[0]);
+        }
+      }
+
+      global.bnbLimit ??= {};
+      global.bnbLimitTs ??= {};
+      for (let type of types) {
+        global.bnbLimitTs[type] ??= Date.now();
+        let used = r.headers[type] ?? 0;
+        if (Date.now() - global.bnbLimitTs[type] > 5000) {
+          global.bnbLimitTs[type] = Date.now();
+          global.bnbLimit[type] = 0; // reset every 5s
+        }
+        if (!isNaN(used)) {
+          global.bnbLimit[type] ??= Number(used);
+          global.bnbLimit[type] = Math.max(global.bnbLimit[type], used);
+        } else global.bnbLimit[type] ??= used; // x-mbx-uuid
+      }
+      return raw ? r : rs;
+    })
+    .catch(function (e) {
+      console.log(e?.response?.data);
+      return e?.response?.data; // { code: 51999, msg: 'System abnormality.' }
+    });
+  return r;
+}
+
+class api {
+  constructor(apiKey = "", secret = "", { testnet } = {}) {
+    this.apiKey = apiKey;
+    this.secret = secret;
+    this.testnet = testnet ?? 0;
+  }
+  init(data = {}) {
+    return { data, apiKey: this.apiKey, secret: this.secret, testnet: this.testnet };
+  }
+  async get(path, data = {}, { raw } = {}) {
+    let dt = this.init(data);
+    dt.raw = raw ?? 0;
+    return call(path, dt);
+  }
+  async post(path, data = {}, { raw } = {}) {
+    let dt = this.init(data);
+    dt.method = "POST";
+    dt.raw = raw ?? 0;
+    return call(path, dt);
+  }
+  async put(path, data = {}, { raw } = {}) {
+    let dt = this.init(data);
+    dt.method = "PUT";
+    dt.raw = raw ?? 0;
+    return call(path, dt);
+  }
+  async delete(path, data = {}, { raw } = {}) {
+    let dt = this.init(data);
+    dt.method = "DELETE";
+    dt.raw = raw ?? 0;
+    return call(path, dt);
+  }
+  async getPublic(path, data = {}, { raw } = {}) {
+    let dt = this.init(data);
+    dt.secret = "";
+    dt.raw = raw ?? 0;
+    return call(path, dt);
+  }
+}
+
+module.exports = api;
+module.exports.call = call;

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "asterdex",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "aster",
+    "api"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.13.2",
+    "crypto-js": "^4.2.0"
+  }
+}