bfx-api-node-plugin-seq-audit
v1.0.3
Published
Automatic sequence number verification plugin for the Bitfinex Node API
Downloads
13
Readme
Bitfinex Sequence Number Audit Plugin for the Node.JS API
This plugin enables the sequence reporting flag upon connecting, and emits an error
event upon receiving an invalid sequence number.
Note that the manager proxies the event as ws2:error
. If subscribing on a socket instance (wsState.ev.on(...)
) use the internal event name, otherwise use the manager name with manager.onWS(...)
.
Features
- Automatically enables sequence numbers on all connections
- Emits a
ws2:error
event in case of sequence number miss-match
Installation
npm i --save bfx-api-node-plugin-seq-audit
Quickstart & Example
const debug = require('debug')('bfx:api:plugins:seq-audit:example')
const { Manager, subscribe } = require('bfx-api-node-core')
const SeqAuditPlugin = require('../')
const SYMBOL = 'tBTCUSD'
const mgr = new Manager({
transform: true,
plugins: [SeqAuditPlugin()]
})
mgr.onWS('open', {}, () => debug('connection open'))
// Catch checksum errors
mgr.onWS('ws2:error', {}, (err) => {
if (err.message.match(/invalid(.*)seq/)) {
debug('recv invalid seq # error: %s', err.message)
}
})
const wsState = mgr.openWS()
subscribe(wsState, 'trades', { symbol: SYMBOL })
Docs
For an executable example, see examples/usage.js
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