JSPM – bfx-hf-ext-plugin-bitfinex@1.0.0

Package Exports

bfx-hf-ext-plugin-bitfinex

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bfx-hf-ext-plugin-bitfinex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

HF Bitfinex Exchange Plugin

This is the standard Bitfinex exchange adapter for the Honey Framework, for usage with bfx-hf-algo and any consumer of bfx-hf-models. It implements Trade and Candle sync methods, along with an algo order adapter necessary for executing algo orders with bfx-hf-algo.

Using the DB schema

const HFDBLowDBAdapter = require('bfx-hf-models-adapter-lowdb')
const { schema: HFDBBitfinexSchema } = require('bfx-hf-ext-plugin-bitfinex')
const HFDB = require('bfx-hf-models')

const db = new HFDB({
  schema: HFDBBitfinexSchema,
  adapter: HFDBLowDBAdapter({
    dbPath: './SOME_DB_PATH.json',
    schema: HFDBBitfinexSchema
  })
})

// db can now be used throughout the HF for data storage

Using the algo order adapter

const { AOAdapter } = require('bfx-hf-ext-plugin-bitfinex')
const AOServer = require('bfx-hf-algo-server')
const db = {} // init as specified above

const adapter = new AOAdapter({
  apiKey: '...',
  apiSecret: '...',
  withHeartbeat: true, // optionally broadcasts a heartbeat to notify the BFX UI
                       // that a bfx ao host is available for orders
})

const server = new AOServer({
  db,
  adapter,
  port: 8877,
  aos: [ /* ... */ ], // see bfx-hf-algo
})

// orders submitted to the AO server will now be routed to bitfinex