coin-hive - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

package.json

 {
   "name": "coin-hive",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "",
@@ -11,5 +11,8 @@ "main": "src/index.js",
   "dependencies": {
+    "elegant-spinner": "^1.0.1",
     "express": "^4.15.4",
+    "log-update": "^2.1.0",
     "minimist": "^1.2.0",
-    "puppeteer": "^0.10.2"
+    "puppeteer": "^0.10.2",
+    "tty-table": "^2.5.5"
   },
@@ -16,0 +19,0 @@ "bin": {

README.md

@@ -9,14 +9,2 @@ # Coin-Hive [![Build Status](https://travis-ci.org/cazala/coin-hive.svg?branch=master)](https://travis-ci.org/cazala/coin-hive)
 
-## What is this?
-
-This package just does the following:
-
-1. Launch a local server that serves a page where CoinHive's Javascript miner is embedded.
-
-2. Launch puppeteer (a headless chrome) pointing to that page.
-
-3. Expose an API that allows you to interact with that miner from node.js (starting, stopping, etc).
-
-The purpose of this package is to allow you to run CoinHive's JavaScript miner from node.js (otherwise it only works on the browser).
-
 ## Install
@@ -34,12 +22,4 @@
 
-  // Options are not mandatory, defaults values:
-  const options = {
-    interval: 1000, // interval for "update"
-    port: 3002, // puppeteer port
-    host: 'localhost', // puppeteer host,
-    threads: -1 // number of threads to start with, defaults to navigator.hardwareConcurrency see https://coin-hive.com/documentation/miner#constructor-options
-  }
-
   // Create miner
-  const miner = await CoinHive('ZM4gjqQ0jh0jbZ3tZDByOXAjyotDbo00', options); // Coin-Hive's Site Key
+  const miner = await CoinHive('ZM4gjqQ0jh0jbZ3tZDByOXAjyotDbo00'); // Coin-Hive's Site Key
 
@@ -81,4 +61,14 @@ // Start miner
 
-- `CoinHive(siteKey)`: Returns a promise of a `Miner` instance. It requires a [Coin-Hive Site Key](https://coin-hive.com/settings/sites).
+- `CoinHive(siteKey [, options])`: Returns a promise of a `Miner` instance. It requires a [Coin-Hive Site Key](https://coin-hive.com/settings/sites). The `options` object is not mandatory and may contain the following properties:
 
+  - `interval`: Interval between `update` events in ms. Default is `1000`.
+
+  - `port`: Port for the miner server. Default is `3002`.
+
+  - `host`: Host for the miner server. Default is `localhost`.
+
+  - `threads`: Number of threads. Default is `navigator.hardwareConcurrency` (number of CPU cores).
+  
+  - `proxy`: Puppeteer's proxy socket 5/4 (ie: `socks5://127.0.0.1:9050`).
+
 - `miner.start()`: Connect to the pool and start mining. Returns a promise that will resolve once the miner is started.
@@ -136,3 +126,3 @@
 
-- `COINHIVE_PROXY`: Proxy socket 5/4 (ie: `COINHIVE_PROXY=socks5://127.0.0.1:9050`)
+- `COINHIVE_PROXY`: Puppeteer's proxy socket 5/4 (ie: `COINHIVE_PROXY=socks5://127.0.0.1:9050`)
 
@@ -139,0 +129,0 @@ ## Requisites

src/miner.js

@@ -40,3 +40,4 @@ var miner = null;
         acceptedHashes: miner.getAcceptedHashes(),
-        threads: miner.getNumThreads()
+        threads: miner.getNumThreads(),
+        autoThreads: miner.getAutoThreadsEnabled(),
       }
@@ -43,0 +44,0 @@ console.log('update:', update)

No alert changes

Improved metrics

Total package byte prevSize

17277

increased by9.04%

Lines of code

211

increased by0.48%

Worsened metrics

Dependency count

6

increased by100%

Number of lines in readme file

128

decreased by-7.25%

Dependency changes

• + Addedelegant-spinner@^1.0.1

• + Addedlog-update@^2.1.0

• + Addedtty-table@^2.5.5

• + Addedansi-escapes@3.2.0(transitive)

• + Addedansi-regex@3.0.15.0.1(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedbreakword@1.0.6(transitive)

• + Addedcamelcase@5.3.1(transitive)

• + Addedchalk@3.0.0(transitive)

• + Addedcli-cursor@2.1.0(transitive)

• + Addedcliui@6.0.0(transitive)

• + Addedclone@1.0.4(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedcsv@5.5.3(transitive)

• + Addedcsv-generate@3.4.3(transitive)

• + Addedcsv-parse@4.16.3(transitive)

• + Addedcsv-stringify@5.6.5(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addeddefaults@1.0.4(transitive)

• + Addedelegant-spinner@1.0.1(transitive)

• + Addedemoji-regex@8.0.0(transitive)

• + Addedfind-up@4.1.0(transitive)

• + Addedget-caller-file@2.0.5(transitive)

• + Addedgrapheme-splitter@1.0.4(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedis-fullwidth-code-point@2.0.03.0.0(transitive)

• + Addedlocate-path@5.0.0(transitive)

• + Addedlog-update@2.3.0(transitive)

• + Addedmimic-fn@1.2.0(transitive)

• + Addedmixme@0.5.10(transitive)

• + Addedonetime@2.0.1(transitive)

• + Addedp-limit@2.3.0(transitive)

• + Addedp-locate@4.1.0(transitive)

• + Addedp-try@2.2.0(transitive)

• + Addedpath-exists@4.0.0(transitive)

• + Addedrequire-directory@2.1.1(transitive)

• + Addedrequire-main-filename@2.0.0(transitive)

• + Addedrestore-cursor@2.0.0(transitive)

• + Addedset-blocking@2.0.0(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedsmartwrap@1.2.5(transitive)

• + Addedstream-transform@2.1.3(transitive)

• + Addedstring-width@2.1.14.2.3(transitive)

• + Addedstrip-ansi@4.0.06.0.1(transitive)

• + Addedsupports-color@7.2.0(transitive)

• + Addedtty-table@2.8.13(transitive)

• + Addedwcwidth@1.0.1(transitive)

• + Addedwhich-module@2.0.1(transitive)

• + Addedwrap-ansi@3.0.16.2.0(transitive)

• + Addedy18n@4.0.3(transitive)

• + Addedyargs@15.4.1(transitive)

• + Addedyargs-parser@18.1.3(transitive)