bfx-api-node-plugin-managed-ob - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "bfx-api-node-plugin-managed-ob",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Maintains complete local order books for the Bitfinex Node API",
@@ -34,4 +34,4 @@ "engines": {
   "dependencies": {
-    "bfx-api-node-core": "git+http://github.com/bitfinexcom/bfx-api-node-core.git#semver:^1.1.0",
-    "bfx-api-node-models": "git+http://github.com/bitfinexcom/bfx-api-node-models.git#semver:^1.0.12",
+    "bfx-api-node-core": "^1.1.0",
+    "bfx-api-node-models": "^1.0.12",
     "bluebird": "^3.5.5",
@@ -38,0 +38,0 @@ "debug": "^4.1.1",

README.md

@@ -1,2 +0,2 @@
-# Bitfinex Node API Managed OrderBook Plugin
+# Bitfinex Managed OrderBook Plugin for the Node.JS API
 
@@ -9,8 +9,36 @@ [![Build Status](https://travis-ci.org/bitfinexcom/bfx-api-node-plugin-managed-ob.svg?branch=master)](https://travis-ci.org/bitfinexcom/bfx-api-node-plugin-managed-ob)
 
-### Example
+### Features
+
+* Maintains up-to-date `OrderBook` models internally
+* Emits a new 'managed:book' event with a full `OrderBook` instance on each update
+
+### Installation
+
+```bash
+npm i --save bfx-api-node-plugin-managed-ob
+```
+
+### Quickstart
+
 ```js
-'use strict'
+const { Manager } = require('bfx-api-node-core')
+const ManagedOBPlugin = require('bfx-api-node-plugin-managed-ob')
 
-process.env.DEBUG = '*'
+const mgr = new Manager({
+  plugins: [ManagedOBPlugin()]
+})
 
+// set up a connection, event listeners, etc
+
+mgr.onWS('managed:book', {}, (ob) => {
+  debug('checksum: %s', ob.checksum())
+})
+```
+
+### Docs
+
+For an executable example, [see `examples/usage.js`](/examples/usage.js)
+
+### Example
+```js
 const debug = require('debug')('bfx:api:plugins:managed-ob:example')
@@ -46,1 +74,9 @@ const { Manager, subscribe } = require('bfx-api-node-core')
 ```
+
+### 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

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Git dependency

Supply chain risk

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

Found 2 instances in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8281

increased by10.49%

Number of lines in readme file

81

increased by80%

Number of high supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

• + Addedansi-regex@2.1.1(transitive)

• + Addedansi-styles@2.2.1(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@0.2.01.0.0(transitive)

• + Addedasync@2.6.4(transitive)

• + Addedaws-sign2@0.6.0(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedbfx-api-node-core@1.6.1(transitive)

• + Addedbfx-api-node-models@1.8.2(transitive)

• + Addedbfx-api-node-rest@4.6.1(transitive)

• + Addedbfx-api-node-util@1.0.12(transitive)

• + Addedbfx-api-node-ws1@1.0.4(transitive)

• + Addedbignumber.js@9.1.2(transitive)

• + Addedbl@1.0.3(transitive)

• + Addedbluebird@3.5.5(transitive)

• + Addedboom@2.10.1(transitive)

• + Addedcaseless@0.11.0(transitive)

• + Addedchalk@1.1.3(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedcommander@2.20.3(transitive)

• + Addedcore-util-is@1.0.21.0.3(transitive)

• + Addedcrc-32@1.2.0(transitive)

• + Addedcryptiles@2.0.5(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddebug@4.1.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedexit-on-epipe@1.0.1(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@1.0.1(transitive)

• + Addedgenerate-function@2.3.1(transitive)

• + Addedgenerate-object-property@1.2.0(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedhar-validator@2.0.6(transitive)

• + Addedhas-ansi@2.0.0(transitive)

• + Addedhawk@3.1.3(transitive)

• + Addedhoek@2.16.3(transitive)

• + Addedhttp-signature@1.1.1(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-my-ip-valid@1.0.1(transitive)

• + Addedis-my-json-valid@2.20.6(transitive)

• + Addedis-property@1.0.2(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsonpointer@5.0.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addednode-uuid@1.4.8(transitive)

• + Addedoauth-sign@0.8.2(transitive)

• + Addedpinkie@2.0.4(transitive)

• + Addedpinkie-promise@2.0.1(transitive)

• + Addedprintj@1.1.2(transitive)

• + Addedprocess-nextick-args@1.0.7(transitive)

• + Addedqs@5.2.1(transitive)

• + Addedreadable-stream@2.0.6(transitive)

• + Addedrequest@2.67.0(transitive)

• + Addedrequest-promise@4.2.0(transitive)

• + Addedrequest-promise-core@1.1.1(transitive)

• + Addedsafe-buffer@5.0.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsntp@1.0.9(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedstealthy-require@1.1.1(transitive)

• + Addedstring_decoder@0.10.31(transitive)

• + Addedstringstream@0.0.6(transitive)

• + Addedstrip-ansi@3.0.1(transitive)

• + Addedsupports-color@2.0.0(transitive)

• + Addedtough-cookie@2.2.2(transitive)

• + Addedtunnel-agent@0.4.3(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addedultron@1.1.1(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedverror@1.10.0(transitive)

• + Addedws@3.0.08.18.0(transitive)

• + Addedxtend@4.0.2(transitive)

• Updatedbfx-api-node-core@^1.1.0

• Updatedbfx-api-node-models@^1.0.12