Merge pull request #583 from ZIMkaRU/bugfix/fix-ws-transport-to-suppo…

…rt-new-rest-api-signature Fix ws transport to support new rest api signature
bitfinexcom · Jun 2, 2023 · 45e8a0d · 45e8a0d
2 parents 08a085a + df7889b
commit 45e8a0d
Show file tree

Hide file tree

Showing 11 changed files with 363 additions and 128 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,7 +1,8 @@
 6.0.0
 - removed unused deps: chai, request-promise, request, crc-32
 - removed bluebird Promise
-- bumped bfx-api-node-rest version up to 5.1.0, breaks previous versions compatibility
+- update params of submitOrder and cancelOrders methods of WS transport to support new rest api signature
+- bumped bfx-api-node-rest version up to 5.1.1, breaks previous versions compatibility
 - bumped mocha, jsdoc-to-markdown, docdash, blessed-contrib, ws versions to fix vulnerabilities
 - moved dev deps readline-promise, blessed, blessed-contrib, cli-table3, p-iteration into corresponding section
 

diff --git a/docs/WS2Manager.html b/docs/WS2Manager.html
@@ -5111,7 +5111,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 11 2023 15:44:15 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue May 30 2023 11:56:58 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/WSv2.html b/docs/WSv2.html
diff --git a/docs/global.html b/docs/global.html
@@ -497,7 +497,7 @@ <h5 class="h5-types">Type:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 11 2023 15:44:15 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue May 30 2023 11:56:58 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -239,7 +239,7 @@ <h3>Contributing</h3>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 11 2023 15:44:15 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue May 30 2023 11:56:58 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/transports_ws2.js.html b/docs/transports_ws2.js.html
@@ -1929,7 +1929,8 @@ <h1 class="page-title">transports/ws2.js</h1>
    * @see WSv2#cancelOrder
    * @see WSv2#updateOrder
    *
-   * @param {object|Array} order - order object model or array
+   * @param {object|Array} params - parameters or order object model or array
+   * @param {object|Array} params.order - order object model or array
    * @returns {Promise} p - resolves on submit notification
    * @example
    * const o = new Order({
@@ -1944,11 +1945,12 @@ <h1 class="page-title">transports/ws2.js</h1>
    *
    * console.log('order confirmed! status: %s', o.status)
    */
-  async submitOrder (order) {
+  async submitOrder (params) {
     if (!this._isAuthenticated) {
       throw new Error('not authenticated')
     }
 
+    const order = params?.order ?? params
     const packet = Array.isArray(order)
       ? order
       : order instanceof Order
@@ -2025,15 +2027,18 @@ <h1 class="page-title">transports/ws2.js</h1>
    *
    * @see WSv2#submitOrder
    *
-   * @param {object[]|Array[]|number[]} orders - array of order models, arrays
+   * @param {object|object[]|Array[]|number[]} params - parameters or array of order models, arrays
+   * @param {object[]|Array[]|number[]} params.ids - array of order models, arrays
    *   or IDs to be cancelled
    * @returns {Promise} p
    */
-  async cancelOrders (orders) {
+  async cancelOrders (params) {
     if (!this._isAuthenticated) {
       throw new Error('not authenticated')
     }
 
+    const orders = params?.ids ?? params
+
     return Promise.all(orders.map(o => {
       return this.cancelOrder(o)
     }))
@@ -2855,7 +2860,7 @@ <h1 class="page-title">transports/ws2.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 11 2023 15:44:15 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue May 30 2023 11:56:58 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/util_precision.js.html b/docs/util_precision.js.html
@@ -106,7 +106,7 @@ <h1 class="page-title">util/precision.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 11 2023 15:44:15 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue May 30 2023 11:56:58 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/util_ws2.js.html b/docs/util_ws2.js.html
@@ -72,7 +72,7 @@ <h1 class="page-title">util/ws2.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 11 2023 15:44:15 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue May 30 2023 11:56:58 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/ws2_manager.js.html b/docs/ws2_manager.js.html
@@ -619,7 +619,7 @@ <h1 class="page-title">ws2_manager.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 11 2023 15:44:15 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue May 30 2023 11:56:58 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/lib/transports/ws2.js b/lib/transports/ws2.js
@@ -1882,7 +1882,8 @@ class WSv2 extends EventEmitter {
    * @see WSv2#cancelOrder
    * @see WSv2#updateOrder
    *
-   * @param {object|Array} order - order object model or array
+   * @param {object|Array} params - parameters or order object model or array
+   * @param {object|Array} params.order - order object model or array
    * @returns {Promise} p - resolves on submit notification
    * @example
    * const o = new Order({
@@ -1897,11 +1898,12 @@ class WSv2 extends EventEmitter {
    *
    * console.log('order confirmed! status: %s', o.status)
    */
-  async submitOrder (order) {
+  async submitOrder (params) {
     if (!this._isAuthenticated) {
       throw new Error('not authenticated')
     }
 
+    const order = params?.order ?? params
     const packet = Array.isArray(order)
       ? order
       : order instanceof Order
@@ -1978,15 +1980,18 @@ class WSv2 extends EventEmitter {
    *
    * @see WSv2#submitOrder
    *
-   * @param {object[]|Array[]|number[]} orders - array of order models, arrays
+   * @param {object|object[]|Array[]|number[]} params - parameters or array of order models, arrays
+   * @param {object[]|Array[]|number[]} params.ids - array of order models, arrays
    *   or IDs to be cancelled
    * @returns {Promise} p
    */
-  async cancelOrders (orders) {
+  async cancelOrders (params) {
     if (!this._isAuthenticated) {
       throw new Error('not authenticated')
     }
 
+    const orders = params?.ids ?? params
+
     return Promise.all(orders.map(o => {
       return this.cancelOrder(o)
     }))

diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
   "version": "6.0.0",
   "description": "Node reference library for Bitfinex API",
   "engines": {
-    "node": ">=8.3.0"
+    "node": ">=16.20.0"
   },
   "main": "index.js",
   "husky": {
@@ -56,8 +56,8 @@
     "standard": "^16.0.3"
   },
   "dependencies": {
-    "bfx-api-node-models": "^1.4.0",
-    "bfx-api-node-rest": "^5.1.0",
+    "bfx-api-node-models": "^1.7.1",
+    "bfx-api-node-rest": "^5.1.1",
     "bfx-api-node-util": "^1.0.10",
     "bfx-api-node-ws1": "^1.0.0",
     "bignumber.js": "9.0.0",