crypto-hashing - npm Package Compare versions

Comparing version 0.3.1 to 1.0.0

CHANGELOG.md

@@ -0,1 +1,5 @@
+1.0.0 / 2016-03-30
+------------------
+- changed interface. See [#2][#2]
+
 0.3.1 / 2014-04-19
@@ -12,2 +16,7 @@ ------------------
 ------------------
-* added method `sha256ripe160`
+* added method `sha256ripe160`
+
+<!--- extract functions from bitcoinjs-lib [enhancement] -->
+[#2]: https://github.com/cryptocoinjs/crypto-hashing/pull/2
+<!--- Make options optional for sha256ripe160 -->
+[#1]: https://github.com/cryptocoinjs/crypto-hashing/pull/1

package.json

 {
   "name": "crypto-hashing",
-  "version": "0.3.1",
-  "description": "Easy interfaces for cryptographic hash functions",
+  "version": "1.0.0",
+  "description": "Hash functions for bitcoin and other cryptocurrencies",
   "keywords": [
-    "cryptography",
-    "hashing"
+    "hash160",
+    "hash256",
+    "ripemd160",
+    "sha1",
+    "sha256",
+    "sha512",
+    "bitcoin",
+    "cryptocurrency",
+    "hash"
   ],
-  "main": "./lib/hashing.js",
+  "homepage": "https://github.com/cryptocoinjs/crypto-hashing",
+  "bugs": {
+    "url": "https://github.com/cryptocoinjs/crypto-hashing/issues"
+  },
+  "license": "MIT",
+  "files": [
+    "index.js"
+  ],
+  "main": "./index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cryptocoinjs/crypto-hashing"
+  },
+  "scripts": {
+    "lint": "standard",
+    "test": "npm run lint && npm run unit",
+    "unit": "tape test/*.js"
+  },
   "dependencies": {
-    "binstring": "0.2.x",
-    "ripemd160": "~0.2.0"
+    "create-hash": "^1.1.2"
   },
   "devDependencies": {
-    "mocha": "1.*",
-    "mochify": "~0.4.2"
-  },
-  "repository": {
-    "url": "https://github.com/cryptocoinjs/crypto-hashing",
-    "type": "git"
-  },
-  "author": "Brooks Boyd <[e-mail]>"
+    "hash-test-vectors": "^1.3.2",
+    "standard": "^6.0.8",
+    "tape": "^4.5.1"
+  }
 }

README.md

@@ -1,29 +0,26 @@
-# Crypto Hashing
+# crypto-hashing
 
-Provides a common interface for cryptographic hash functions commonly used in cryptocoin protocols.
+[![NPM Package](https://img.shields.io/npm/v/crypto-hashing.svg?style=flat-square)](https://www.npmjs.org/package/crypto-hashing)
+[![Build Status](https://img.shields.io/travis/cryptocoinjs/crypto-hashing.svg?branch=master&style=flat-square)](https://travis-ci.org/cryptocoinjs/crypto-hashing)
+[![Dependency status](https://img.shields.io/david/cryptocoinjs/crypto-hashing.svg?style=flat-square)](https://david-dm.org/cryptocoinjs/crypto-hashing#info=dependencies)
 
-## Usage
-If only interested in sub-set of hashes, reference just that function of the exported module:
+[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
 
-```js
-var sha256 = require('crypto-hashing').sha256;
+###### Available functions:
 
-console.log(sha256('hello'));
-console.log(sha256.x2('hello'));
-```
+In addition to functions from [crypto-browserify/createHash](https://github.com/crypto-browserify/createHash):
+- hash160 (sha256 and then ripemd160)
+- hash256 (sha256 twice)
 
-Or reference the whole module for all the functions:
+###### Example
 
 ```js
-var hash = require('crypto-hashing');
-
-console.log(hash.sha256('hello'));
-console.log(hash.ripemd160('hello'));
+var cryptoHash = require('crypto-hashing')
+var buffer = new Buffer('Hello there!')
+console.log(cryptoHash('hash256', buffer).toString('hex'))
+// e365181d0a42d3f57906af24c80d4636158455d140734c85e80609fa7d100300
 ```
 
-## Test
+## License
 
-Unit tests are written in [Mocha](http://visionmedia.github.io/mocha/). To run the test suite, install mocha either by installing it globally or installing the development dependencies with NPM. Then, from within the project's folder run `mocha`.
-
-
-
+MIT

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance 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

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

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

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

decreased by-50%

Number of low license alerts

0

decreased by-100%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

4153

decreased by-62.79%

Dev dependency count

3

increased by50%

Number of package files

5

decreased by-44.44%

Lines of code

15

decreased by-90.91%

Number of lines in readme file

27

decreased by-10%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedcreate-hash@^1.1.2

• + Addedcipher-base@1.0.4(transitive)

• + Addedcreate-hash@1.2.0(transitive)

• + Addedhash-base@3.1.0(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedmd5.js@1.3.5(transitive)

• + Addedreadable-stream@3.6.2(transitive)

• + Addedripemd160@2.0.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsha.js@2.4.11(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• - Removedbinstring@0.2.x

• - Removedripemd160@~0.2.0

• - Removedbinstring@0.2.1(transitive)

• - Removedripemd160@0.2.1(transitive)