btc-api-node 1.12.7

package/.istanbul.yml

@@ -0,0 +1,53 @@
+verbose: false
+instrumentation:
+    root: .
+    extensions:
+        - .js
+    default-excludes: true
+    excludes: []
+    embed-source: false
+    variable: __coverage__
+    compact: true
+    preserve-comments: false
+    complete-copy: false
+    save-baseline: false
+    baseline-file: ./coverage/coverage-baseline.json
+    include-all-sources: false
+    include-pid: false
+reporting:
+    print: summary
+    reports:
+        - lcov
+    dir: ./source/images/coverage
+    watermarks:
+        statements: [50, 80]
+        lines: [50, 80]
+        functions: [50, 80]
+        branches: [50, 80]
+    report-config:
+        clover: {file: clover.xml}
+        cobertura: {file: cobertura-coverage.xml}
+        json: {file: coverage-final.json}
+        json-summary: {file: coverage-summary.json}
+        lcovonly: {file: lcov.info}
+        teamcity: {file: null, blockName: Code Coverage Summary}
+        text: {file: null, maxCols: 0}
+        text-lcov: {file: lcov.info}
+        text-summary: {file: null}
+hooks:
+    hook-run-in-context: false
+    post-require-hook: null
+    handle-sigint: false
+check:
+    global:
+        statements: 0
+        lines: 0
+        branches: 0
+        functions: 0
+        excludes: []
+    each:
+        statements: 0
+        lines: 0
+        branches: 0
+        functions: 0
+        excludes: []

package/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+
+language: node_js
+node_js:
+  - "stable"

package/CHANGELOG

@@ -0,0 +1,33 @@
+2.0.0
+
+- WS API v2: added optional auto-reconnect
+- WS API v2: added optional packet watchdog
+- WS API v2: added optional order packet buffering via multi-op endpoint
+- WS API v2: added optional order book & candle managment/persistence
+- WS API v2: added optional seq number verification/audit
+- WS API v2: added many extra callback/listener funcs (i.e. onMaintenanceStart)
+- WS API v2: added ability to mass-unsubscribe listeners by group ID
+- WS API v2: most callback methods now support message filtering
+- WS API v2: replaced transform logic w/ model classes (i.e. Order)
+- WS API v2: many methods now return promises, such as submitOrder()
+- REST API v2: transform method updated to match WSv2 class
+- REST API v1: minor refactor, methods unchanged
+- REST API v2: minor refactor, methods unchanged
+- WS API v1: minor refactor, methods unchanged
+- BFX constructor exposes & caches clients on `.rest()` and `.ws()` methods
+- Updated ws2 examples
+- Added model classes (OrderBook, Order, Trade, etc)
+
+1.2.1
+
+- REST API v2: use /candles/ endpoint for candles data
+- WS API v2: Candles event provides key
+- Improve error message for nonce errors
+- Examples: added example for WS2 orders
+
+1.2.0
+
+- REST API v1: Added support for `/orders/hist` endpoint
+- REST API v2: Added support for `auth/r/trades/{symbol}/hist` endpoint
+- WS API v2: Candles supports now `key` to identify subscription
+- REST API v1: Fix `claim_position` argument handling

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 bitfinexcom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,211 @@
+# Bitfinex Trading API for Node.JS. Bitcoin, Ether and Litecoin trading
+
+[![Build Status](https://travis-ci.org/bitfinexcom/bitfinex-api-node.svg?branch=master)](https://travis-ci.org/bitfinexcom/bitfinex-api-node)
+
+A Node.JS reference implementation of the Bitfinex API
+
+* Official implementation
+* REST v2 API
+* WebSockets v2 API
+
+Documentation at [https://docs.bitfinex.com/v2/reference](https://docs.bitfinex.com/v2/reference)
+
+## Installation
+```bash
+  npm i bitfinex-api-node
+```
+
+See `doc/` for REST2 and WS2 API methods.
+
+## Usage
+
+Version 2.0.0 of `bitfinex-api-node` supports the v2 REST and WebSocket APIs. The clients for v1 of those APIs are maintained for backwards compatibility, but deprecated.
+
+As network calls are slow, data is sent as arrays. In order to reconstruct key / value pairs, set `opts.transform` to `true` when creating an interface.
+
+The BFX constructor returns a client manager, which can be used to create clients for v1 & v2 of the REST and WebSocket APIs via `.rest()` and `.ws()`. The options for the clients can be defined here, or passed in later
+
+```js
+const BFX = require('bitfinex-api-node')
+
+const bfx = new BFX({
+  apiKey: '...',
+  apiSecret: '...',
+
+  ws: {
+    autoReconnect: true,
+    seqAudit: true,
+    packetWDDelay: 10 * 1000
+  }
+})
+```
+
+The clients are cached per version/options pair, and default to version 2:
+
+```js
+let ws2 = bfx.ws() //
+ws2 = bfx.ws(2)    // same client
+const ws1 = bfx.ws(1)
+
+const rest2 = bfx.rest(2, {
+  // options
+})
+```
+
+The websocket client is recommended for receiving realtime data & notifications
+on completed actions.
+
+For more examples, check the `examples/` folder.
+
+### NOTE: v1 REST and WS clients
+
+Both v1 client classes & server APIs have been deprecated, and will be removed. In the meantime, some methods available via `RESTv1` have been exposed on `RESTv2` to prevent future migration issues. Although the underlying implementation of these methods is likely to change once they are fully ported to v2, the signatures should remain the same.
+
+## WS2 Example: Sending an order & tracking status
+
+```js
+const ws = bfx.ws()
+
+ws.on('error', (err) => console.log(err))
+ws.on('open', ws.auth.bind(ws))
+
+ws.once('auth', () => {
+  const o = new Order({
+    cid: Date.now(),
+    symbol: 'tETHUSD',
+    amount: 0.1,
+    type: Order.type.MARKET
+  }, ws)
+
+  // Enable automatic updates
+  o.registerListeners()
+
+  o.on('update', () => {
+    console.log(`order updated: ${o.serialize()}`)
+  })
+
+  o.on('close', () => {
+    console.log(`order closed: ${o.status}`)
+    ws.close()
+  })
+
+  o.submit().then(() => {
+    console.log(`submitted order ${o.id}`)
+  }).catch((err) => {
+    console.error(err)
+    ws.close()
+  })
+})
+
+ws.open()
+```
+
+## WS2 Example: Cancel all open orders
+
+```js
+const ws = bfx.ws()
+
+ws.on('error', (err) => console.log(err))
+ws.on('open', ws.auth.bind(ws))
+
+ws.onOrderSnapshot({}, (orders) => {
+  if (orders.length === 0) {
+    console.log('no open orders')
+    return
+  }
+
+  console.log(`recv ${orders.length} open orders`)
+
+  ws.cancelOrders(orders).then(() => {
+    console.log('cancelled orders')
+  })
+})
+
+ws.open()
+```
+
+## WS2 Example: Subscribe to trades by pair
+
+```js
+const ws = bfx.ws()
+
+ws.on('error', (err) => console.log(err))
+ws.on('open', () => {
+  ws.onTrade({ pair: 'BTCUSD' }, (trade) => {
+    if (Array.isArray(trade[0])) {
+      console.log(`recv snapshot of ${trade.length} trades`)
+    } else {
+      console.log(`trade: ${JSON.stringify(trade)}`)
+    }
+  })
+})
+
+ws.open()
+```
+
+## Version 2.0.0 Breaking changes:
+
+### constructor takes only an options object now, including the API keys.
+
+Old:
+
+```js
+new BFX(API_KEY, API_SECRET, { version: 2 })
+```
+
+since 2.0.0:
+
+```js
+new BFX({ apiKey: '', apiSecret: '' })
+```
+
+### `trade` and `orderbook` snapshots are emitted as nested lists
+
+To make dealing with snapshots better predictable, snapshots are emitted as an array.
+
+### normalized orderbooks for R0
+
+Lists of raw orderbooks (`R0`) are ordered in the same order as `P0`, `P1`, `P2`, `P3`
+
+## Testing
+
+```bash
+npm test
+```
+
+## FAQ
+
+### My websocket won't connect!
+
+Did you call `open()`? :)
+
+### nonce too small
+
+I make multiple parallel request and I receive an error that the nonce is too small. What does it mean?
+
+Nonces are used to guard against replay attacks. When multiple HTTP requests arrive at the API with the wrong nonce, e.g. because of an async timing issue, the API will reject the request.
+
+If you need to go parallel, you have to use multiple API keys right now.
+
+### How do `te` and `tu` messages differ?
+
+A `te` packet is sent first to the client immediately after a trade has been matched & executed, followed by a `tu` message once it has completed processing. During times of high load, the `tu` message may be noticably delayed, and as such only the `te` message should be used for a realtime feed.
+
+## Contributors
+
+ - Josh Rossi <maximojoshuarossi@gmail.com>
+ - Yago <yago.ftw@gmail.com>
+ - Sean Robertson <sprobertson@gmail.com>
+ - Paolo Ardoino <paolo.ardoino@gmail.com>
+ - Aaron Terry <acterry@gmail.com>
+ - Zachary Belford <belfordz66@gmail.com>
+ - Robert Kowalski <rok@kowalski.gd>
+ - Simone Poggi <motocarota@gmail.com>
+ - Matthew Jesuele <matt@makeapps.io>
+ - dutu <adrian.clinciu@outlook.com>
+ - Tetradeca <31027443+Tetradeca@users.noreply.github.com>
+ - Cameron Lockey <ctlockey@gmail.com>
+ - Andrew <androng@users.noreply.github.com>
+ - Rob Ellis <rob@silentrob.me>
+ - MaxSvargal <maxsvargal@gmail.com>
+ - Cris Mihalache <me@f3rno.com>

package/doc/order.md

@@ -0,0 +1,160 @@
+<a name="Order"></a>
+
+## Order
+High level order model; provides methods for execution & can stay updated via
+a WSv2 connection
+
+**Kind**: global class  
+
+* [Order](#Order)
+    * [new Order(data, ws)](#new_Order_new)
+    * _instance_
+        * [.registerListeners(ws)](#Order+registerListeners)
+        * [.removeListeners(ws)](#Order+removeListeners)
+        * [.cbGID()](#Order+cbGID) ⇒ <code>string</code>
+        * [.submit(ws)](#Order+submit) ⇒ <code>Promise</code>
+        * [.cancel(ws)](#Order+cancel) ⇒ <code>Promise</code>
+        * [.recreate(ws)](#Order+recreate) ⇒ <code>Promise</code>
+        * [.getLastFillAmount()](#Order+getLastFillAmount) ⇒ <code>number</code>
+        * [.getBaseCurrency()](#Order+getBaseCurrency) ⇒ <code>string</code>
+        * [.getQuoteCurrency()](#Order+getQuoteCurrency) ⇒ <code>string</code>
+        * [.getNotionalValue()](#Order+getNotionalValue) ⇒ <code>number</code>
+        * [.serialize()](#Order+serialize) ⇒ <code>Array</code>
+        * [.toNewOrderPacket()](#Order+toNewOrderPacket) ⇒ <code>Object</code>
+    * _static_
+        * [.unserialize(arr)](#Order.unserialize) ⇒ <code>Object</code>
+        * [.getBaseCurrency(arr)](#Order.getBaseCurrency) ⇒ <code>string</code>
+        * [.getQuoteCurrency(arr)](#Order.getQuoteCurrency) ⇒ <code>string</code>
+
+<a name="new_Order_new"></a>
+
+### new Order(data, ws)
+
+| Param | Type | Description |
+| --- | --- | --- |
+| data | <code>Object</code> &#124; <code>Array</code> | either a map of order fields or a raw array |
+| ws | <code>WSv2</code> | optional, saved for a later call to registerListeners() |
+
+<a name="Order+registerListeners"></a>
+
+### order.registerListeners(ws)
+Registers for updates/persistence on the specified ws2 instance
+
+**Kind**: instance method of <code>[Order](#Order)</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ws | <code>WSv2</code> | optional, defaults to internal ws |
+
+<a name="Order+removeListeners"></a>
+
+### order.removeListeners(ws)
+Removes update listeners from the specified ws2 instance
+
+**Kind**: instance method of <code>[Order](#Order)</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ws | <code>WSv2</code> | optional, defaults to internal ws |
+
+<a name="Order+cbGID"></a>
+
+### order.cbGID() ⇒ <code>string</code>
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>string</code> - cbGID  
+<a name="Order+submit"></a>
+
+### order.submit(ws) ⇒ <code>Promise</code>
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>Promise</code> - p  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ws | <code>WSv2</code> | optional, defaults to internal ws |
+
+<a name="Order+cancel"></a>
+
+### order.cancel(ws) ⇒ <code>Promise</code>
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>Promise</code> - p  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ws | <code>WSv2</code> | optional, defaults to internal ws |
+
+<a name="Order+recreate"></a>
+
+### order.recreate(ws) ⇒ <code>Promise</code>
+Equivalent to calling cancel() followed by submit()
+
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>Promise</code> - p  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| ws | <code>WSv2</code> | optional, defaults to internal ws |
+
+<a name="Order+getLastFillAmount"></a>
+
+### order.getLastFillAmount() ⇒ <code>number</code>
+Query the amount that was filled on the last order update
+
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>number</code> - amount  
+<a name="Order+getBaseCurrency"></a>
+
+### order.getBaseCurrency() ⇒ <code>string</code>
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>string</code> - currency  
+<a name="Order+getQuoteCurrency"></a>
+
+### order.getQuoteCurrency() ⇒ <code>string</code>
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>string</code> - currency  
+<a name="Order+getNotionalValue"></a>
+
+### order.getNotionalValue() ⇒ <code>number</code>
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>number</code> - value  
+<a name="Order+serialize"></a>
+
+### order.serialize() ⇒ <code>Array</code>
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>Array</code> - o  
+<a name="Order+toNewOrderPacket"></a>
+
+### order.toNewOrderPacket() ⇒ <code>Object</code>
+Creates an order map that can be passed to the `on` command.
+
+**Kind**: instance method of <code>[Order](#Order)</code>  
+**Returns**: <code>Object</code> - o  
+<a name="Order.unserialize"></a>
+
+### Order.unserialize(arr) ⇒ <code>Object</code>
+**Kind**: static method of <code>[Order](#Order)</code>  
+**Returns**: <code>Object</code> - order  
+
+| Param | Type |
+| --- | --- |
+| arr | <code>Array</code> | 
+
+<a name="Order.getBaseCurrency"></a>
+
+### Order.getBaseCurrency(arr) ⇒ <code>string</code>
+**Kind**: static method of <code>[Order](#Order)</code>  
+**Returns**: <code>string</code> - currency - base currency from symbol  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| arr | <code>Array</code> | order in ws2 array format |
+
+<a name="Order.getQuoteCurrency"></a>
+
+### Order.getQuoteCurrency(arr) ⇒ <code>string</code>
+**Kind**: static method of <code>[Order](#Order)</code>  
+**Returns**: <code>string</code> - currency - quote currency from symbol  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| arr | <code>Array</code> | order in ws2 array format |
+