Merge pull request #107 from ZIMkaRU/feature/add-weighted-averages

Add weighted averages
bitfinexcom · Jul 3, 2023 · 9ac0807 · 9ac0807
2 parents ddd5062 + d6abc72
commit 9ac0807
Show file tree

Hide file tree

Showing 10 changed files with 669 additions and 673 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+# 5.3.0
+- RESTv2: add getWeightedAverages method
+
 # 5.2.0
 - RESTv2: add payCurrencyConversionList method
 - RESTv2: add payAddCurrencyConversion method

diff --git a/docs/RESTv1.html b/docs/RESTv1.html
diff --git a/docs/RESTv2.html b/docs/RESTv2.html
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/rest1.js.html b/docs/rest1.js.html
diff --git a/docs/rest2.js.html b/docs/rest2.js.html
diff --git a/lib/rest2.js b/lib/rest2.js
@@ -47,7 +47,8 @@ const {
   TransactionFee,
   AccountSummary,
   AuthPermission,
-  CoreSettings
+  CoreSettings,
+  WeightedAverages
 } = require('bfx-api-node-models')
 
 const BASE_TIMEOUT = 15000
@@ -734,6 +735,24 @@ class RESTv2 {
     }, cb, Trade)
   }
 
+  /**
+   * @param {object} [params]        - parameters
+   * @param {string} [params.symbol] - query symbol
+   * @param {number} [params.start]  - query start
+   * @param {number} [params.end]    - query end
+   * @param {number} [params.limit]  - query limit
+   * @param {Function} [cb]          - legacy callback
+   * @returns {Promise} p
+   */
+  getWeightedAverages (params = {}, cb = null) {
+    const { symbol, start, end, limit } = params
+    const url = '/auth/r/trades/calc'
+
+    return this._makeAuthRequest(url, {
+      symbol, start, end, limit
+    }, cb, WeightedAverages)
+  }
+
   /**
    * @param {object} [params]       - parameters
    * @param {number} [params.start] - query start

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bfx-api-node-rest",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Official Bitfinex REST v1 & v2 API interfaces",
   "engines": {
     "node": ">=8.3.0"
@@ -45,7 +45,7 @@
     "url": "https://github.com/bitfinexcom/bfx-api-node-rest/issues"
   },
   "devDependencies": {
-    "bfx-api-mock-srv": "^1.5.0",
+    "bfx-api-mock-srv": "^1.6.0",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "docdash": "^1.2.0",
@@ -59,7 +59,7 @@
     "standard": "^17.0.0"
   },
   "dependencies": {
-    "bfx-api-node-models": "^1.7.1",
+    "bfx-api-node-models": "^1.8.0",
     "bfx-api-node-util": "^1.0.10",
     "debug": "4.1.1",
     "dirty-chai": "^2.0.1",

diff --git a/test/lib/rest-2-integration.js b/test/lib/rest-2-integration.js
@@ -176,6 +176,7 @@ describe('RESTv2 integration (mock server) tests', () => {
     ['payCurrencyList','pay_currency_list', [{}]],
     ['payInvoiceUpdate','pay_invoice_update', [{}]],
     ['payInvoiceCreatePos','pay_invoice_create_pos', [{}]],
+    ['getWeightedAverages', 'weighted_averages.sym.start.end.limit', [{ symbol: 'sym', start: 'start', end: 'end', limit: 'limit' }]]
   ]
 
   methods.forEach((m) => {