bfx-api-node-core/lib/ws2/init_state.js

Core Bitfinex Node API

'use strict'

const _mapValues = require('lodash/mapValues')
const { nonce } = require('bfx-api-node-util')

const initPluginState = require('../plugins/init_state')
const { WS_URL } = require('../config')
const open = require('./open')

/**
 * Creates & opens a WSv2 API connection, and returns the resulting state object
 *
 * @param {Object} opts
 * @param {string?} opts.url - defaults to production Bitfinex WSv2 API url
 * @param {Object?} opts.agent - connection agent
 * @param {boolean?} opts.transform - if true, raw API data arrays will be automatically converted to bfx-api-node-models instances
 * @param {Object?} opts.authArgs - auth details
 * @param {string?} opts.authArgs.apiKey - for later authentication
 * @param {string?} opts.authArgs.apiSecret - for later authentication
 * @param {string?} opts.authArgs.authToken - for later authentication; takes priority over apiKey and apiSecret
 * @param {Object?} opts.plugins - optional set of plugins to use with the connection
 * @return {Object} state
 */
const initState = (opts = {}) => {
  const {
    agent,
    authArgs = {},
    plugins = {},
    transform,
    url = WS_URL,
    autoResubscribe = true
  } = opts

  const { ev, ws } = open(url, agent)
  const emit = (type, ...args) => { // queue emit on end of call chain
    setTimeout(() => {
      ev.emit(type, ...args)
    }, 0)
  }

  return {
    channels: {},
    pendingSubscriptions: [],
    pendingUnsubscriptions: [],
    plugins: _mapValues(plugins, initPluginState),
    id: nonce(),
    isOpen: false,
    sendBuffer: [],

    authArgs,
    transform,
    autoResubscribe,
    agent,
    emit,
    url,
    ev,
    ws
  }
}

module.exports = initState