Merge pull request #77 from avsek477/add-visible-on-hit-hidden-orders

Add visible on hit hidden orders

Author: prdn

CHANGELOG

@@ -1,3 +1,6 @@
+#1.6.2
+- feature: visible on hit option supported for hidden orders
+
 # 1.6.0
 - feature: Core settings model
 

lib/order.js

@@ -8,6 +8,7 @@ const _isEmpty = require('lodash/isEmpty')
 const _compact = require('lodash/compact')
 const _flatten = require('lodash/flatten')
 const _includes = require('lodash/includes')
+const _isBoolean = require('lodash/isBoolean')
 const _isUndefined = require('lodash/isUndefined')
 const { prepareAmount, preparePrice } = require('bfx-api-node-util')
 
@@ -101,6 +102,7 @@ class Order extends Model {
 
     if (!this.flags) this.flags = 0
     if (!_isUndefined(data.hidden)) this.setHidden(data.hidden)
+    if (!_isUndefined(data.visibleOnHit)) this.setVisibleOnHit(data.visibleOnHit)
     if (!_isUndefined(data.postonly)) this.setPostOnly(data.postonly)
     if (!_isUndefined(data.reduceonly)) this.setReduceOnly(data.reduceonly)
     if (!_isUndefined(data.oco)) {
@@ -159,6 +161,7 @@ class Order extends Model {
       /market/.test(type.toLowerCase()) ? 'MARKET' : preparePrice(price),
 
       this.isHidden() && 'hidden',
+      this.isVisibleOnHit() && 'visible-on-hit',
       this.isPostOnly() && 'post-only',
       this.isReduceOnly() && 'reduce-only',
       this.isPositionClose() && 'pos-close',
@@ -182,6 +185,13 @@ class Order extends Model {
     return !!(this.flags & Order.flags.HIDDEN)
   }
 
+  /**
+   * @returns {boolean} visibleOnHit
+   */
+  isVisibleOnHit () {
+    return !!(this.isHidden() && this.meta && this.meta.make_visible)
+  }
+
   /**
    * @returns {boolean} postonly
    */
@@ -236,9 +246,32 @@ class Order extends Model {
    * @returns {number} finalFlags
    */
   setHidden (v) {
+    if (!v && this.meta) {
+      delete this.meta.make_visible
+    }
     return this.modifyFlag(Order.flags.HIDDEN, v)
   }
 
+  /**
+   * Update the meta object. The rest part of the hidden order will be visible
+   * after first hit(partial execution).
+   *
+   * @param {boolean} v - visibleOnHit value
+   * @returns {number} meta
+   */
+  setVisibleOnHit (v) {
+    if (!this.isHidden() || !_isBoolean(v)) {
+      return
+    }
+
+    this.meta = {
+      ...(this.meta || {}),
+      make_visible: +v
+    }
+
+    return this.meta
+  }
+
   /**
    * Update the post-only flag value. If post-only and the order would
    * immediately fill, the order is automatically cancelled.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bfx-api-node-models",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "Object models for usage with the Bitfinex node API",
   "engines": {
     "node": ">=8.3.0"

test/lib/models/order.js

@@ -169,6 +169,23 @@ describe('Order model', () => {
     assert(o.isHidden())
   })
 
+  it('isVisibleOnHit, setVisibleOnHit: updates/reads if the hidden orders are visible on hit or not', () => {
+    const o = new Order()
+    assert(!o.isHidden())
+    assert(!o.isVisibleOnHit())
+
+    o.setVisibleOnHit(true)
+    assert(!o.isVisibleOnHit())
+
+    o.setHidden(true)
+    o.setVisibleOnHit(true)
+    assert(o.isVisibleOnHit())
+
+    o.setHidden(false)
+    assert(!o.isHidden())
+    assert(!o.isVisibleOnHit())
+  })
+
   it('isPostOnly, setPostOnly: updates/reads postonly flag', () => {
     const o = new Order()
     assert(!o.isPostOnly())