https://github.com/bitfinexcom/bfx-hf-data-server
https://github.com/bitfinexcom/bfx-hf-data-server
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitfinexcom/bfx-hf-data-server
- Owner: bitfinexcom
- License: apache-2.0
- Created: 2018-08-08T10:28:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T18:59:43.000Z (over 2 years ago)
- Last Synced: 2025-04-11T06:13:50.589Z (about 1 year ago)
- Language: JavaScript
- Size: 257 KB
- Stars: 13
- Watchers: 7
- Forks: 22
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
## Bitfinex Honey Framework Data Server for Node.JS
[](https://travis-ci.org/bitfinexcom/bfx-hf-data-server)
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:
* [bfx-hf-models-adapter-lowdb](https://github.com/bitfinexcom/bfx-hf-models-adapter-lowdb)
Regardless of the backend, a schema must be specified (providing exchange-specific API methods). The official Bitfinex schema is [bfx-hf-ext-plugin-bitfinex](https://github.com/bitfinexcom/bfx-hf-ext-plugin-bitfinex).
### Installation
For standalone usage:
```bash
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:
```bash
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/`](/examples)
### Example
```js
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
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. 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
```