Bitfinex Honey Framework Data Server for Node.JS
The HF data server runs backtests for the HF UI Electron App. It syncs candle and trade data and then executes the strategy on it for backtesting.
The DB backend is implemented by a plugin:
Regardless of the backend, a schema must be specified (providing exchange-specific API methods). The official Bitfinex schema is bfx-hf-ext-plugin-bitfinex.
Installation
For standalone usage:
git clone https://github.com/bitfinexcom/bfx-hf-data-server
cd bfx-hf-data-server
npm i
cp .env.example .env
npm run start-lowdb
For usage/extension within an existing project:
npm i --save bfx-hf-data-server
Quickstart
Follow the installation instructions, and run npm run start-lowdb
.
Docs
For executable examples, refer to examples/
Example
const DataServer = require('bfx-hf-data-server')
const HFDB = require('bfx-hf-models')
const HFDBLowDBAdapter = require('bfx-hf-models-adapter-lowdb')
const { schema: HFDBBitfinexSchema } = require('bfx-hf-ext-plugin-bitfinex')
const db = new HFDB({
schema: HFDBBitfinexSchema,
adapter: HFDBLowDBAdapter({
dbPath: './SOME_DB_PATH.json',
schema: HFDBBitfinexSchema
})
})
const ds = new DataServer({
port: 8899,
db
})
ds.open()
// data server ready to receive commands
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Note
This package will be maintained only via github, please use latest relases from github instead of npm.
Example on how to install specific version from github:
npm i --save-prod https://github.com/bitfinexcom/bfx-hf-data-server.git#v3.0.4
Example on how to install it latest version from github:
npm i --save-prod https://github.com/bitfinexcom/bfx-hf-data-server.git