bfx-api-node-models/lib/funding_credit.js

Object models for usage with the Bitfinex node API

'use strict'

const numberValidator = require('./validators/number')
const amountValidator = require('./validators/amount')
const symbolValidator = require('./validators/symbol')
const stringValidator = require('./validators/string')
const dateValidator = require('./validators/date')
const boolValidator = require('./validators/bool')
const Model = require('./model')

const statuses = ['ACTIVE', 'EXECUTED', 'PARTIALLY FILLED', 'CANCELED']
const boolFields = ['notify', 'hidden', 'renew', 'noClose']
const fields = {
  id: 0,
  symbol: 1,
  side: 2,
  mtsCreate: 3,
  mtsUpdate: 4,
  amount: 5,
  flags: 6,
  status: 7,
  type: 8,
  rate: 11,
  period: 12,
  mtsOpening: 13,
  mtsLastPayout: 14,
  notify: 15,
  hidden: 16,
  renew: 18,
  rateReal: 19,
  noClose: 20,
  positionPair: 21
}

/**
 * Funding Credit model
 */
class FundingCredit extends Model {
  /**
   * @param {object|Array} data - funding credit data
   * @param {number} data.id - id
   * @param {string} data.symbol - symbol
   * @param {number} data.side - side
   * @param {number} data.mtsCreate - creation timestamp
   * @param {number} data.mtsUpdate - last update timestamp
   * @param {number} data.mtsOpening - open timestamp
   * @param {number} data.mtsLastPayout - last payout timestamp
   * @param {number} data.amount - remaining amount
   * @param {number} data.flags - flags
   * @param {number} data.status - current status
   * @param {number} data.rate - rate
   * @param {number} data.rateReal - rate
   * @param {number} data.period - period
   * @param {string} data.positionPair - position pair
   * @param {number|boolean} data.notify - notify flag
   * @param {number|boolean} data.hidden - hidden flag
   * @param {number|boolean} data.renew - renew flag
   * @param {number|boolean} data.noClose - no-close flag
   */
  constructor (data = {}) {
    super({ data, fields, boolFields })
  }

  /**
   * @param {object[]|object|Array[]|Array} data - data to convert to POJO
   * @returns {object} pojo
   */
  static unserialize (data) {
    return super.unserialize({ data, fields, boolFields })
  }

  /**
   * Validates a given fuding credit instance
   *
   * @param {object[]|object|FundingCredit[]|FundingCredit|Array} data - instance to validate
   * @returns {string} error - null if instance is valid
   */
  static validate (data) {
    return super.validate({
      data,
      fields,
      validators: {
        mtsCreate: dateValidator,
        mtsUpdate: dateValidator,
        mtsOpening: dateValidator,
        mtsLastPayout: dateValidator,
        amount: amountValidator,
        flags: numberValidator,
        rate: numberValidator,
        period: numberValidator,
        rateReal: numberValidator,
        notify: boolValidator,
        hidden: boolValidator,
        renew: boolValidator,
        noClose: boolValidator,
        status: stringValidator,
        symbol: symbolValidator,
        id: numberValidator
      }
    })
  }
}

FundingCredit.status = {}
statuses.forEach(s => (FundingCredit.status[s.split(' ').join('_')] = s))

module.exports = FundingCredit