chore: release version v0.13.0

BREAKING CHANGE: API refactored to use async/await

.gitignore

@@ -1,7 +1,15 @@
+docs
+**/node_modules/
+**/*.log
+test/repo-tests*
+**/bundle.js
+
 # Logs
 logs
 *.log
 
+coverage
+
 # Runtime data
 pids
 *.pid
@@ -19,11 +27,19 @@ coverage
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
+build
-build/Release
 
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
+docs
+lib
 dist
+test/test-data/go-ipfs-repo/LOCK
+test/test-data/go-ipfs-repo/LOG
+test/test-data/go-ipfs-repo/LOG.old
+
+# while testing npm5
+package-lock.json
+yarn.lock

.npmignore

@@ -1,28 +0,0 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Optional npm cache directory
-.npm
-
-# Optional REPL history
-.node_repl_history
-
-test

.travis.yml

@@ -1,37 +1,46 @@
-sudo: false
 language: node_js
+cache: npm
+stages:
+  - check
+  - test
+  - cov
 
-matrix:
+node_js:
+  - '10'
+
+os:
+  - linux
+  - osx
+
+script: npx nyc -s npm run test:node -- --bail
+after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
+
+jobs:
   include:
-  - node_js: 4
+    - os: windows
-    env: CXX=g++-4.8
+      cache: false
-  - node_js: 6
-    env:
-      - CXX=g++-4.8
-  - node_js: stable
-    env: CXX=g++-4.8
-
-# Make sure we have new NPM.
-before_install:
-  - npm install -g npm@4
 
+    - stage: check
       script:
+        - npx aegir commitlint --travis
+        - npx aegir dep-check
         - npm run lint
-  - npm test
-  - npm run coverage
-  - make test
-
-before_script:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
-
-after_success:
-  - npm run coverage-publish
 
+    - stage: test
+      name: chrome
       addons:
-  firefox: 'latest'
+        chrome: stable
-  apt:
+      script:
-    sources:
+        - npx aegir test -t browser
-      - ubuntu-toolchain-r-test
+        - npx aegir test -t webworker
-    packages:
+
-      - g++-4.8
+    - stage: test
+      name: firefox
+      addons:
+        firefox: latest
+      script:
+        - npx aegir test -t browser -- --browsers FirefoxHeadless
+        - npx aegir test -t webworker -- --browsers FirefoxHeadless
+
+notifications:
+  email: false

CHANGELOG.md

@@ -0,0 +1,296 @@
+<a name="0.13.0"></a>
+# [0.13.0](https://github.com/libp2p/js-peer-id/compare/v0.12.2...v0.13.0) (2019-07-11)
+
+
+### Features
+
+* async await ([#87](https://github.com/libp2p/js-peer-id/issues/87)) ([c3463c7](https://github.com/libp2p/js-peer-id/commit/c3463c7))
+
+
+### BREAKING CHANGES
+
+* API refactored to use async/await
+
+
+
+<a name="0.12.2"></a>
+## [0.12.2](https://github.com/libp2p/js-peer-id/compare/v0.12.1...v0.12.2) (2019-01-09)
+
+
+### Bug Fixes
+
+* clean repo and bundle size reduction ([cd20993](https://github.com/libp2p/js-peer-id/commit/cd20993))
+
+
+
+<a name="0.12.1"></a>
+## [0.12.1](https://github.com/libp2p/js-peer-id/compare/v0.12.0...v0.12.1) (2019-01-03)
+
+
+
+<a name="0.12.0"></a>
+# [0.12.0](https://github.com/libp2p/js-peer-id/compare/v0.11.0...v0.12.0) (2018-10-18)
+
+
+### Bug Fixes
+
+* add peerIdWithIs to the API functions using the instance ([2e5e666](https://github.com/libp2p/js-peer-id/commit/2e5e666))
+
+
+### Features
+
+* add class-is module ([6513a02](https://github.com/libp2p/js-peer-id/commit/6513a02))
+
+
+
+<a name="0.11.0"></a>
+# [0.11.0](https://github.com/libp2p/js-peer-id/compare/v0.10.7...v0.11.0) (2018-07-02)
+
+
+### Features
+
+* change toPrint output to match go implementation ([e8ab1b9](https://github.com/libp2p/js-peer-id/commit/e8ab1b9))
+
+
+
+<a name="0.10.7"></a>
+## [0.10.7](https://github.com/libp2p/js-peer-id/compare/v0.10.6...v0.10.7) (2018-04-05)
+
+
+
+<a name="0.10.6"></a>
+## [0.10.6](https://github.com/libp2p/js-peer-id/compare/v0.10.5...v0.10.6) (2018-02-12)
+
+
+
+<a name="0.10.5"></a>
+## [0.10.5](https://github.com/libp2p/js-peer-id/compare/v0.10.4...v0.10.5) (2018-01-28)
+
+
+
+<a name="0.10.4"></a>
+## [0.10.4](https://github.com/libp2p/js-peer-id/compare/v0.10.3...v0.10.4) (2017-12-20)
+
+
+### Bug Fixes
+
+* update dependencies ([#73](https://github.com/libp2p/js-peer-id/issues/73)) ([8b9a134](https://github.com/libp2p/js-peer-id/commit/8b9a134))
+
+
+
+<a name="0.10.3"></a>
+## [0.10.3](https://github.com/libp2p/js-peer-id/compare/v0.10.2...v0.10.3) (2017-12-01)
+
+
+### Bug Fixes
+
+* catch error when unmarshaling instead of crashing ([#72](https://github.com/libp2p/js-peer-id/issues/72)) ([156911e](https://github.com/libp2p/js-peer-id/commit/156911e))
+
+
+
+<a name="0.10.2"></a>
+## [0.10.2](https://github.com/libp2p/js-peer-id/compare/v0.10.1...v0.10.2) (2017-10-12)
+
+
+### Bug Fixes
+
+* Always add public key to constructor if possible, Fix for undefined pubKey in remote peers ([#68](https://github.com/libp2p/js-peer-id/issues/68)) ([3abdcda](https://github.com/libp2p/js-peer-id/commit/3abdcda))
+
+
+
+<a name="0.10.1"></a>
+## [0.10.1](https://github.com/libp2p/js-peer-id/compare/v0.10.0...v0.10.1) (2017-09-07)
+
+
+### Features
+
+* **deps:** update aegir and libp2p-crypto ([#67](https://github.com/libp2p/js-peer-id/issues/67)) ([d7088d6](https://github.com/libp2p/js-peer-id/commit/d7088d6))
+
+
+
+<a name="0.10.0"></a>
+# [0.10.0](https://github.com/libp2p/js-peer-id/compare/v0.9.0...v0.10.0) (2017-09-03)
+
+
+### Features
+
+* p2p addrs situation ([#66](https://github.com/libp2p/js-peer-id/issues/66)) ([63428fa](https://github.com/libp2p/js-peer-id/commit/63428fa))
+
+
+
+<a name="0.9.0"></a>
+# [0.9.0](https://github.com/libp2p/js-peer-id/compare/v0.8.8...v0.9.0) (2017-07-22)
+
+
+### Features
+
+* use next libp2p-crypto ([#64](https://github.com/libp2p/js-peer-id/issues/64)) ([442df13](https://github.com/libp2p/js-peer-id/commit/442df13))
+
+
+
+<a name="0.8.8"></a>
+## [0.8.8](https://github.com/libp2p/js-peer-id/compare/v0.8.7...v0.8.8) (2017-07-21)
+
+
+
+<a name="0.8.7"></a>
+## [0.8.7](https://github.com/libp2p/js-peer-id/compare/v0.8.6...v0.8.7) (2017-04-03)
+
+
+### Features
+
+* set privKey pubKey ([ac27907](https://github.com/libp2p/js-peer-id/commit/ac27907))
+
+
+
+<a name="0.8.6"></a>
+## [0.8.6](https://github.com/libp2p/js-peer-id/compare/v0.8.5...v0.8.6) (2017-03-30)
+
+
+### Features
+
+* isEqual ([3f4f670](https://github.com/libp2p/js-peer-id/commit/3f4f670))
+
+
+
+<a name="0.8.5"></a>
+## [0.8.5](https://github.com/libp2p/js-peer-id/compare/v0.8.4...v0.8.5) (2017-03-27)
+
+
+### Bug Fixes
+
+* avoid using constructor.name ([a3fe1a2](https://github.com/libp2p/js-peer-id/commit/a3fe1a2))
+
+
+### Features
+
+* isPeerId ([0acc572](https://github.com/libp2p/js-peer-id/commit/0acc572))
+
+
+
+<a name="0.8.4"></a>
+## [0.8.4](https://github.com/libp2p/js-peer-id/compare/v0.8.2...v0.8.4) (2017-03-16)
+
+
+
+<a name="0.8.2"></a>
+## [0.8.2](https://github.com/libp2p/js-peer-id/compare/v0.8.1...v0.8.2) (2017-02-09)
+
+
+
+<a name="0.8.1"></a>
+## [0.8.1](https://github.com/libp2p/js-peer-id/compare/v0.8.0...v0.8.1) (2016-12-18)
+
+
+### Features
+
+* cache b58 id ([bebb0a7](https://github.com/libp2p/js-peer-id/commit/bebb0a7))
+* create b58 string on creation and throw on id mutation ([78d96d0](https://github.com/libp2p/js-peer-id/commit/78d96d0))
+
+
+
+<a name="0.8.0"></a>
+# [0.8.0](https://github.com/libp2p/js-peer-id/compare/v0.7.0...v0.8.0) (2016-11-03)
+
+
+* Async Crypto Endeavour (#33) ([31701e2](https://github.com/libp2p/js-peer-id/commit/31701e2))
+
+
+### BREAKING CHANGES
+
+* This changes the interface of .create, .createFromPrivKey,
+.createFromPubKey, .createFromJSON
+
+
+
+<a name="0.7.0"></a>
+# [0.7.0](https://github.com/libp2p/js-peer-id/compare/v0.6.7...v0.7.0) (2016-05-26)
+
+
+### Bug Fixes
+
+* code review and docs and go interop ([58f1933](https://github.com/libp2p/js-peer-id/commit/58f1933))
+* use new version of libp2p-crypto ([ab55046](https://github.com/libp2p/js-peer-id/commit/ab55046))
+
+
+
+<a name="0.6.7"></a>
+## [0.6.7](https://github.com/libp2p/js-peer-id/compare/v0.6.6...v0.6.7) (2016-05-23)
+
+
+
+<a name="0.6.6"></a>
+## [0.6.6](https://github.com/libp2p/js-peer-id/compare/v0.6.5...v0.6.6) (2016-04-12)
+
+
+
+<a name="0.6.5"></a>
+## [0.6.5](https://github.com/libp2p/js-peer-id/compare/v0.6.1...v0.6.5) (2016-04-12)
+
+
+
+<a name="0.6.1"></a>
+## [0.6.1](https://github.com/libp2p/js-peer-id/compare/v0.6.0...v0.6.1) (2016-03-15)
+
+
+
+<a name="0.6.0"></a>
+# [0.6.0](https://github.com/libp2p/js-peer-id/compare/v0.5.3...v0.6.0) (2016-03-10)
+
+
+
+<a name="0.5.3"></a>
+## [0.5.3](https://github.com/libp2p/js-peer-id/compare/v0.5.1...v0.5.3) (2016-03-05)
+
+
+
+<a name="0.5.1"></a>
+## [0.5.1](https://github.com/libp2p/js-peer-id/compare/v0.5.0...v0.5.1) (2016-03-03)
+
+
+
+<a name="0.5.0"></a>
+# [0.5.0](https://github.com/libp2p/js-peer-id/compare/v0.4.0...v0.5.0) (2016-02-14)
+
+
+
+<a name="0.4.0"></a>
+# [0.4.0](https://github.com/libp2p/js-peer-id/compare/v0.3.4...v0.4.0) (2015-11-05)
+
+
+
+<a name="0.3.4"></a>
+## [0.3.4](https://github.com/libp2p/js-peer-id/compare/v0.3.3...v0.3.4) (2015-10-28)
+
+
+
+<a name="0.3.3"></a>
+## [0.3.3](https://github.com/libp2p/js-peer-id/compare/v0.3.2...v0.3.3) (2015-09-15)
+
+
+
+<a name="0.3.2"></a>
+## [0.3.2](https://github.com/libp2p/js-peer-id/compare/v0.3.1...v0.3.2) (2015-09-14)
+
+
+
+<a name="0.3.1"></a>
+## [0.3.1](https://github.com/libp2p/js-peer-id/compare/v0.3.0...v0.3.1) (2015-08-25)
+
+
+
+<a name="0.3.0"></a>
+# [0.3.0](https://github.com/libp2p/js-peer-id/compare/v0.2.0...v0.3.0) (2015-07-19)
+
+
+
+<a name="0.2.0"></a>
+# [0.2.0](https://github.com/libp2p/js-peer-id/compare/v0.1.0...v0.2.0) (2015-07-17)
+
+
+
+<a name="0.1.0"></a>
+# 0.1.0 (2015-07-08)
+
+
+

README.md

@@ -1,16 +1,22 @@
 # peer-id
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
-[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![Build Status](https://travis-ci.org/libp2p/js-peer-id.svg?style=flat-square)](https://travis-ci.org/libp2p/js-peer-id)
+[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
-[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-peer-id/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-peer-id?branch=master)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![](https://img.shields.io/codecov/c/github/libp2p/js-peer-id.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-peer-id)
+[![](https://img.shields.io/travis/libp2p/js-peer-id.svg?style=flat-square)](https://travis-ci.com/libp2p/js-peer-id)
 [![Dependency Status](https://david-dm.org/libp2p/js-peer-id.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-id)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
-![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)
 
 > [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
 
+## Lead Maintainer
+
+[Pedro Teixeira](https://github.com/pgte)
+
+## Table of Contents
+
 - [Description](#description)
 - [Example](#example)
 - [Installation](#installation)
@@ -22,7 +28,7 @@
 - [API](#api)
   - [Create](#create)
     - [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
-    - [`create([opts], callback)`](#createopts-callback)
+    - [`create([opts])`](#createopts)
   - [Import](#import)
     - [`createFromHexString(str)`](#createfromhexstringstr)
     - [`createFromBytes(buf)`](#createfrombytesbuf)
@@ -51,11 +57,10 @@ The public key is a base64 encoded string of a protobuf containing an RSA DER bu
 ```JavaScript
 const PeerId = require('peer-id')
 
-PeerId.create({ bits: 1024 }, (err, id) => {
+const id = await PeerId.create({ bits: 1024 })
-  if (err) { throw err }
 console.log(JSON.stringify(id.toJSON(), null, 2))
-})
 ```
+
 ```bash
 {
   "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
@@ -118,14 +123,13 @@ const PeerId = require('peer-id')
 
 The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto).
 
-### `create([opts], callback)`
+### `create([opts])`
 
 Generates a new Peer ID, complete with public/private keypair.
 
 - `opts: Object`: Default: `{bits: 2048}`
-- `callback: Function`
 
-Calls back `callback` with `err, id`.
+Returns `Promise<PeerId>`.
 
 ## Import
 
@@ -133,30 +137,43 @@ Calls back `callback` with `err, id`.
 
 Creates a Peer ID from hex string representing the key's multihash.
 
+Returns `PeerId.
+
 ### `createFromBytes(buf)`
 
 Creates a Peer ID from a buffer representing the key's multihash.
 
+Returns `PeerId`.
+
 ### `createFromB58String(str)`
+
 Creates a Peer ID from a Base58 string representing the key's multihash.
 
+Returns `PeerId`.
+
 ### `createFromPubKey(pubKey)`
 
 - `publicKey: Buffer`
 
 Creates a Peer ID from a buffer containing a public key.
 
+Returns `Promise<PeerId>`.
+
 ### `createFromPrivKey(privKey)`
 
 - `privKey: Buffer`
 
 Creates a Peer ID from a buffer containing a private key.
 
+Returns `Promise<PeerId>`.
+
 ### `createFromJSON(obj)`
 
 - `obj.id: String` - The multihash encoded in `base58`
-- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
+- `obj.pubKey: String` - The public key in protobuf format, encoded in `base64`
-- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
+- `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
+
+Returns `Promise<PeerId>`.
 
 ## Export
 
@@ -192,10 +209,11 @@ Returns an `obj` of the form
 - `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
 - `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
 
-
 ### `toPrint()`
 
-Alias for `.toJSON()`.
+Returns the Peer ID as a printable string without the `Qm` prefix.
+
+Example: `<peer.ID xxxxxx>`
 
 ### `isEqual(id)`
 

circle.yml

@@ -1,14 +0,0 @@
-machine:
-  node:
-    version: stable
-
-dependencies:
-  pre:
-    - google-chrome --version
-    - curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
-    - sudo dpkg -i google-chrome.deb || true
-    - sudo apt-get update
-    - sudo apt-get install -f
-    - sudo apt-get install --only-upgrade lsb-base
-    - sudo dpkg -i google-chrome.deb
-    - google-chrome --version

package.json

@@ -1,49 +1,48 @@
 {
   "name": "peer-id",
-  "version": "0.8.8",
+  "version": "0.13.0",
   "description": "IPFS Peer Id implementation in Node.js",
+  "leadMaintainer": "Pedro Teixeira <i@pgte.me>",
   "main": "src/index.js",
   "bin": "src/bin.js",
   "scripts": {
-    "lint": "aegir-lint",
+    "lint": "aegir lint",
-    "build": "aegir-build",
+    "build": "aegir build",
-    "test": "aegir-test",
+    "test": "aegir test",
-    "test:node": "aegir-test node",
+    "test:node": "aegir test -t node",
-    "test:browser": "aegir-test browser",
+    "test:browser": "aegir test -t browser -t webworker",
-    "release": "aegir-release",
+    "release": "aegir release",
-    "release-minor": "aegir-release --type minor",
+    "release-minor": "aegir release --type minor",
-    "release-major": "aegir-release --type major",
+    "release-major": "aegir release --type major",
-    "coverage": "aegir-coverage",
+    "coverage": "aegir coverage",
-    "coverage-publish": "aegir-coverage publish"
+    "size": "bundlesize -f dist/index.min.js -s 140kB"
   },
+  "files": [
+    "src",
+    "dist"
+  ],
   "keywords": [
     "IPFS"
   ],
-  "author": "David Dias <daviddias@ipfs.io>",
   "license": "MIT",
-  "pre-commit": [
-    "lint",
-    "test"
-  ],
   "engines": {
-    "node": ">=4.0.0",
+    "node": ">=10.0.0",
-    "npm": ">=3.0.0"
+    "npm": ">=6.0.0"
   },
   "bugs": {
     "url": "https://github.com/libp2p/js-peer-id/issues"
   },
   "homepage": "https://github.com/libp2p/js-peer-id",
   "devDependencies": {
-    "aegir": "^11.0.2",
+    "aegir": "^19.0.5",
-    "chai": "^4.1.0",
+    "bundlesize": "~0.18.0",
-    "dirty-chai": "^2.0.1",
+    "chai": "^4.2.0",
-    "pre-commit": "^1.2.2"
+    "dirty-chai": "^2.0.1"
   },
   "dependencies": {
-    "async": "^2.5.0",
+    "class-is": "^1.1.0",
-    "libp2p-crypto": "~0.8.8",
+    "libp2p-crypto": "~0.17.0",
-    "lodash": "^4.17.4",
+    "multihashes": "~0.4.14"
-    "multihashes": "~0.4.5"
   },
   "repository": {
     "type": "git",
@@ -53,11 +52,21 @@
     "David Dias <daviddias.p@gmail.com>",
     "David Dias <mail@daviddias.me>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Henrique Dias <hacdias@gmail.com>",
+    "Hugo Dias <hugomrdias@gmail.com>",
+    "Maciej Krüger <mkg20001@gmail.com>",
+    "Michael Garvin <gar+gh@danger.computer>",
+    "Pedro Teixeira <i@pgte.me>",
     "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
+    "Richard Schneider <makaretu@gmail.com>",
     "Stephen Whitmore <stephen.whitmore@gmail.com>",
+    "Vasco Santos <vasco.santos@ua.pt>",
+    "Vasco Santos <vasco.santos@moxy.studio>",
+    "Yahya <ya7yaz@gmail.com>",
     "greenkeeperio-bot <support@greenkeeper.io>",
     "nginnever <ginneversource@gmail.com>",
-    "npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>"
+    "npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>",
+    "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
   ]
 }

src/bin.js

@@ -4,10 +4,9 @@
 
 const PeerId = require('./index.js')
 
-PeerId.create((err, id) => {
+async function main () {
-  if (err) {
+  const id = await PeerId.create()
-    throw err
+  console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console
 }
 
-  console.log(JSON.stringify(id.toJSON(), null, 2))
+main()
-})

src/index.js

@@ -5,9 +5,9 @@
 'use strict'
 
 const mh = require('multihashes')
-const crypto = require('libp2p-crypto')
+const cryptoKeys = require('libp2p-crypto/src/keys')
 const assert = require('assert')
-const waterfall = require('async/waterfall')
+const withIs = require('class-is')
 
 class PeerId {
   constructor (id, privKey, pubKey) {
@@ -56,20 +56,30 @@ class PeerId {
   // Return the protobuf version of the public key, matching go ipfs formatting
   marshalPubKey () {
     if (this.pubKey) {
-      return crypto.marshalPublicKey(this.pubKey)
+      return cryptoKeys.marshalPublicKey(this.pubKey)
     }
   }
 
   // Return the protobuf version of the private key, matching go ipfs formatting
   marshalPrivKey () {
     if (this.privKey) {
-      return crypto.marshalPrivateKey(this.privKey)
+      return cryptoKeys.marshalPrivateKey(this.privKey)
     }
   }
 
-  // pretty print
   toPrint () {
-    return this.toJSON()
+    let pid = this.toB58String()
+    // All sha256 nodes start with Qm
+    // We can skip the Qm to make the peer.ID more useful
+    if (pid.startsWith('Qm')) {
+      pid = pid.slice(2)
+    }
+    let maxRunes = 6
+    if (pid.length < maxRunes) {
+      maxRunes = pid.length
+    }
+
+    return '<peer.ID ' + pid.substr(0, maxRunes) + '>'
   }
 
   // return the jsonified version of the key, matching the formatting
@@ -108,150 +118,111 @@ class PeerId {
   /*
    * Check if this PeerId instance is valid (privKey -> pubKey -> Id)
    */
-  isValid (callback) {
+  isValid () {
-    // TODO Needs better checking
+    // TODO: needs better checking
-    if (this.privKey &&
+    return Boolean(this.privKey &&
       this.privKey.public &&
       this.privKey.public.bytes &&
       Buffer.isBuffer(this.pubKey.bytes) &&
-      this.privKey.public.bytes.equals(this.pubKey.bytes)) {
+      this.privKey.public.bytes.equals(this.pubKey.bytes))
-      callback()
-    } else {
-      callback(new Error('Keys not match'))
-    }
   }
 }
 
-exports = module.exports = PeerId
+const PeerIdWithIs = withIs(PeerId, {
+  className: 'PeerId',
+  symbolName: '@libp2p/js-peer-id/PeerId'
+})
+
+exports = module.exports = PeerIdWithIs
 
 // generation
-exports.create = function (opts, callback) {
+exports.create = async (opts) => {
-  if (typeof opts === 'function') {
-    callback = opts
-    opts = {}
-  }
   opts = opts || {}
   opts.bits = opts.bits || 2048
 
-  waterfall([
+  const key = await cryptoKeys.generateKeyPair('RSA', opts.bits)
-    (cb) => crypto.generateKeyPair('RSA', opts.bits, cb),
+  const digest = await key.public.hash()
-    (privKey, cb) => privKey.public.hash((err, digest) => {
+
-      cb(err, digest, privKey)
+  return new PeerIdWithIs(digest, key)
-    })
-  ], (err, digest, privKey) => {
-    if (err) {
-      return callback(err)
 }
 
-    callback(null, new PeerId(digest, privKey))
+exports.createFromHexString = (str) => {
-  })
+  return new PeerIdWithIs(mh.fromHexString(str))
 }
 
-exports.createFromHexString = function (str) {
+exports.createFromBytes = (buf) => {
-  return new PeerId(mh.fromHexString(str))
+  return new PeerIdWithIs(buf)
 }
 
-exports.createFromBytes = function (buf) {
+exports.createFromB58String = (str) => {
-  return new PeerId(buf)
+  return new PeerIdWithIs(mh.fromB58String(str))
-}
-
-exports.createFromB58String = function (str) {
-  return new PeerId(mh.fromB58String(str))
 }
 
 // Public Key input will be a buffer
-exports.createFromPubKey = function (key, callback) {
+exports.createFromPubKey = async (key) => {
-  if (typeof callback !== 'function') {
-    throw new Error('callback is required')
-  }
-
   let buf = key
+
   if (typeof buf === 'string') {
-    buf = new Buffer(key, 'base64')
+    buf = Buffer.from(key, 'base64')
   }
 
-  const pubKey = crypto.unmarshalPublicKey(buf)
+  if (!Buffer.isBuffer(buf)) {
-
+    throw new Error('Supplied key is neither a base64 string nor a buffer')
-  pubKey.hash((err, digest) => {
-    if (err) {
-      return callback(err)
   }
 
-    callback(null, new PeerId(digest, null, pubKey))
+  const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
-  })
+  const digest = await pubKey.hash()
+  return new PeerIdWithIs(digest, null, pubKey)
 }
 
 // Private key input will be a string
-exports.createFromPrivKey = function (key, callback) {
+exports.createFromPrivKey = async (key) => {
   let buf = key
+
   if (typeof buf === 'string') {
-    buf = new Buffer(key, 'base64')
+    buf = Buffer.from(key, 'base64')
   }
 
-  if (typeof callback !== 'function') {
+  if (!Buffer.isBuffer(buf)) {
-    throw new Error('callback is required')
+    throw new Error('Supplied key is neither a base64 string nor a buffer')
   }
 
-  waterfall([
+  const privKey = await cryptoKeys.unmarshalPrivateKey(buf)
-    (cb) => crypto.unmarshalPrivateKey(buf, cb),
+  const digest = await privKey.public.hash()
-    (privKey, cb) => privKey.public.hash((err, digest) => {
+
-      cb(err, digest, privKey)
+  return new PeerIdWithIs(digest, privKey, privKey.public)
-    })
-  ], (err, digest, privKey) => {
-    if (err) {
-      return callback(err)
 }
 
-    callback(null, new PeerId(digest, privKey))
+exports.createFromJSON = async (obj) => {
-  })
+  let id = mh.fromB58String(obj.id)
+  let rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
+  let rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
+  let pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
+
+  if (!rawPrivKey) {
+    return new PeerIdWithIs(id, null, pub)
   }
 
-exports.createFromJSON = function (obj, callback) {
+  const privKey = await cryptoKeys.unmarshalPrivateKey(rawPrivKey)
-  if (typeof callback !== 'function') {
+  const privDigest = await privKey.public.hash()
-    throw new Error('callback is required')
+  let pubDigest
-  }
 
-  const id = mh.fromB58String(obj.id)
-  const rawPrivKey = obj.privKey && new Buffer(obj.privKey, 'base64')
-  const rawPubKey = obj.pubKey && new Buffer(obj.pubKey, 'base64')
-  const pub = rawPubKey && crypto.unmarshalPublicKey(rawPubKey)
-
-  if (rawPrivKey) {
-    waterfall([
-      (cb) => crypto.unmarshalPrivateKey(rawPrivKey, cb),
-      (priv, cb) => priv.public.hash((err, digest) => {
-        cb(err, digest, priv)
-      }),
-      (privDigest, priv, cb) => {
   if (pub) {
-          pub.hash((err, pubDigest) => {
+    pubDigest = await pub.hash()
-            cb(err, privDigest, priv, pubDigest)
-          })
-        } else {
-          cb(null, privDigest, priv)
-        }
-      }
-    ], (err, privDigest, priv, pubDigest) => {
-      if (err) {
-        return callback(err)
   }
 
   if (pub && !privDigest.equals(pubDigest)) {
-        return callback(new Error('Public and private key do not match'))
+    throw new Error('Public and private key do not match')
   }
 
   if (id && !privDigest.equals(id)) {
-        return callback(new Error('Id and private key do not match'))
+    throw new Error('Id and private key do not match')
   }
 
-      callback(null, new PeerId(id, priv, pub))
+  return new PeerIdWithIs(id, privKey, pub)
-    })
-  } else {
-    callback(null, new PeerId(id, null, pub))
-  }
 }
 
-exports.isPeerId = function (peerId) {
+exports.isPeerId = (peerId) => {
   return Boolean(typeof peerId === 'object' &&
     peerId._id &&
     peerId._idB58String)

test/peer-id.spec.js

@@ -8,10 +8,11 @@ chai.use(dirtyChai)
 const expect = chai.expect
 const crypto = require('libp2p-crypto')
 const mh = require('multihashes')
-const parallel = require('async/parallel')
 
 const PeerId = require('../src')
 
+const util = require('util')
+
 const testId = require('./fixtures/sample-id')
 const testIdHex = testId.id
 const testIdBytes = mh.fromHexString(testId.id)
@@ -19,38 +20,35 @@ const testIdB58String = mh.toB58String(testIdBytes)
 
 const goId = require('./fixtures/go-private-key')
 
+// Test options for making PeerId.create faster
+// INSECURE, only use when testing
+const testOpts = {
+  bits: 512
+}
+
 describe('PeerId', () => {
   it('create an id without \'new\'', () => {
     expect(PeerId).to.throw(Error)
   })
 
-  it('create a new id', (done) => {
+  it('create a new id', async () => {
-    PeerId.create((err, id) => {
+    const id = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
     expect(id.toB58String().length).to.equal(46)
-      done()
-    })
   })
 
-  it('isPeerId', (done) => {
+  it('isPeerId', async () => {
-    PeerId.create((err, id) => {
+    const id = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
     expect(PeerId.isPeerId(id)).to.equal(true)
     expect(PeerId.isPeerId('aaa')).to.equal(false)
-      expect(PeerId.isPeerId(new Buffer('batatas'))).to.equal(false)
+    expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
-      done()
-    })
   })
 
-  it('throws on changing the id', (done) => {
+  it('throws on changing the id', async () => {
-    PeerId.create((err, id) => {
+    const id = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
     expect(id.toB58String().length).to.equal(46)
     expect(() => {
-        id.id = new Buffer('hello')
+      id.id = Buffer.from('hello')
     }).to.throw(/immutable/)
-      done()
-    })
   })
 
   it('recreate an Id from Hex string', () => {
@@ -68,60 +66,44 @@ describe('PeerId', () => {
     expect(testIdB58String).to.equal(id.toB58String())
   })
 
-  it('Recreate from a Public Key', (done) => {
+  it('Recreate from a Public Key', async () => {
-    PeerId.createFromPubKey(testId.pubKey, (err, id) => {
+    const id = await PeerId.createFromPubKey(testId.pubKey)
-      expect(err).to.not.exist()
     expect(testIdB58String).to.equal(id.toB58String())
-      done()
-    })
   })
 
-  it('Recreate from a Private Key', (done) => {
+  it('Recreate from a Private Key', async () => {
-    PeerId.createFromPrivKey(testId.privKey, (err, id) => {
+    const id = await PeerId.createFromPrivKey(testId.privKey)
-      expect(err).to.not.exist()
     expect(testIdB58String).to.equal(id.toB58String())
-
+    const encoded = Buffer.from(testId.privKey, 'base64')
-      const encoded = new Buffer(testId.privKey, 'base64')
+    const id2 = await PeerId.createFromPrivKey(encoded)
-      PeerId.createFromPrivKey(encoded, (err, id2) => {
-        expect(err).to.not.exist()
     expect(testIdB58String).to.equal(id2.toB58String())
-        done()
+    expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
-      })
-    })
   })
 
-  it('Compare generated ID with one created from PubKey', (done) => {
+  it('Compare generated ID with one created from PubKey', async () => {
-    PeerId.create((err, id1) => {
+    const id1 = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
+    const id2 = await PeerId.createFromPubKey(id1.marshalPubKey())
-
-      PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
-        expect(err).to.not.exist()
     expect(id1.id).to.be.eql(id2.id)
-        done()
-      })
-    })
   })
 
-  it('Non-default # of bits', (done) => {
+  it('Works with default options', async function () {
-    PeerId.create({ bits: 1024 }, (err, shortId) => {
+    this.timeout(10000)
-      expect(err).to.not.exist()
+    const id = await PeerId.create()
-      PeerId.create({ bits: 4096 }, (err, longId) => {
+    expect(id.toB58String().length).to.equal(46)
-        expect(err).to.not.exist()
+  })
+
+  it('Non-default # of bits', async function () {
+    this.timeout(1000 * 60)
+    const shortId = await PeerId.create(testOpts)
+    const longId = await PeerId.create({ bits: 1024 })
     expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
-        done()
-      })
-    })
   })
 
-  it('Pretty printing', (done) => {
+  it('Pretty printing', async () => {
-    PeerId.create((err, id1) => {
+    const id1 = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
+    const id2 = await PeerId.createFromPrivKey((id1.toJSON()).privKey)
-      PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
-        expect(err).to.not.exist()
     expect(id1.toPrint()).to.be.eql(id2.toPrint())
-        done()
+    expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>')
-      })
-    })
   })
 
   it('toBytes', () => {
@@ -129,110 +111,88 @@ describe('PeerId', () => {
     expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
   })
 
-  it('isEqual', (done) => {
+  it('isEqual', async () => {
-    parallel([
+    const ids = await Promise.all([
-      (cb) => PeerId.create(cb),
+      PeerId.create(testOpts),
-      (cb) => PeerId.create(cb)
+      PeerId.create(testOpts)
-    ], (err, ids) => {
+    ])
-      expect(err).to.not.exist()
+
     expect(ids[0].isEqual(ids[0])).to.equal(true)
     expect(ids[0].isEqual(ids[1])).to.equal(false)
     expect(ids[0].isEqual(ids[0].id)).to.equal(true)
     expect(ids[0].isEqual(ids[1].id)).to.equal(false)
-      done()
-    })
   })
 
   describe('fromJSON', () => {
-    it('full node', (done) => {
+    it('full node', async () => {
-      PeerId.create({ bits: 1024 }, (err, id) => {
+      const id = await PeerId.create(testOpts)
-        expect(err).to.not.exist()
+      const other = await PeerId.createFromJSON(id.toJSON())
-
-        PeerId.createFromJSON(id.toJSON(), (err, other) => {
-          expect(err).to.not.exist()
       expect(id.toB58String()).to.equal(other.toB58String())
       expect(id.privKey.bytes).to.eql(other.privKey.bytes)
       expect(id.pubKey.bytes).to.eql(other.pubKey.bytes)
-          done()
-        })
-      })
     })
 
-    it('only id', (done) => {
+    it('only id', async () => {
-      crypto.generateKeyPair('RSA', 1024, (err, key) => {
+      const key = await crypto.keys.generateKeyPair('RSA', 1024)
-        expect(err).to.not.exist()
+      const digest = await key.public.hash()
-        key.public.hash((err, digest) => {
-          expect(err).to.not.exist()
-
       const id = PeerId.createFromBytes(digest)
       expect(id.privKey).to.not.exist()
       expect(id.pubKey).to.not.exist()
+      const other = await PeerId.createFromJSON(id.toJSON())
+      expect(id.toB58String()).to.equal(other.toB58String())
+    })
 
-          PeerId.createFromJSON(id.toJSON(), (err, other) => {
+    it('go interop', async () => {
-            expect(err).to.not.exist()
+      const id = await PeerId.createFromJSON(goId)
-            expect(
+      const digest = await id.privKey.public.hash()
-              id.toB58String()
+      expect(mh.toB58String(digest)).to.eql(goId.id)
-            ).to.equal(
-              other.toB58String()
-            )
-            done()
-          })
-        })
     })
   })
 
-    it('go interop', (done) => {
+  it('set privKey (valid)', async () => {
-      PeerId.createFromJSON(goId, (err, id) => {
+    const peerId = await PeerId.create(testOpts)
-        expect(err).to.not.exist()
-        id.privKey.public.hash((err, digest) => {
-          expect(err).to.not.exist()
-          expect(
-            mh.toB58String(digest)
-          ).to.be.eql(
-            goId.id
-          )
-          done()
-        })
-      })
-    })
-  })
-
-  it('set privKey (valid)', (done) => {
-    PeerId.create((err, peerId) => {
-      expect(err).to.not.exist()
     peerId.privKey = peerId._privKey
-      peerId.isValid(done)
+    expect(peerId.isValid()).to.equal(true)
-    })
   })
 
-  it('set pubKey (valid)', (done) => {
+  it('set pubKey (valid)', async () => {
-    PeerId.create((err, peerId) => {
+    const peerId = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
     peerId.pubKey = peerId._pubKey
-      peerId.isValid(done)
+    expect(peerId.isValid()).to.equal(true)
-    })
   })
 
-  it('set privKey (invalid)', (done) => {
+  it('set privKey (invalid)', async () => {
-    PeerId.create((err, peerId) => {
+    const peerId = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
+    peerId.privKey = Buffer.from('bufff')
-      peerId.privKey = new Buffer('bufff')
+    expect(peerId.isValid()).to.equal(false)
-      peerId.isValid((err) => {
-        expect(err).to.exist()
-        done()
-      })
-    })
   })
 
-  it('set pubKey (invalid)', (done) => {
+  it('set pubKey (invalid)', async () => {
-    PeerId.create((err, peerId) => {
+    const peerId = await PeerId.create(testOpts)
-      expect(err).to.not.exist()
+    peerId.pubKey = Buffer.from('bufff')
-      peerId.pubKey = new Buffer('buffff')
+    expect(peerId.isValid()).to.equal(false)
-      peerId.isValid((err) => {
+  })
+
+  describe('returns error via cb instead of crashing', () => {
+    const garbage = [
+      Buffer.from('00010203040506070809', 'hex'),
+      {}, null, false, undefined, true, 1, 0,
+      Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
+    ]
+
+    const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON']
+
+    for (const gb of garbage) {
+      for (const fn of fncs) {
+        it(`${fn} (${util.inspect(gb)})`, async () => {
+          try {
+            await PeerId[fn](gb)
+          } catch (err) {
             expect(err).to.exist()
-        done()
+          }
-      })
         })
+      }
+    }
   })
 
   describe('throws on inconsistent data', () => {
@@ -240,45 +200,34 @@ describe('PeerId', () => {
     let k2
     let k3
 
-    before((done) => {
+    before(async () => {
-      parallel([
+      const keys = await Promise.all([
-        (cb) => crypto.generateKeyPair('RSA', 1024, cb),
+        crypto.keys.generateKeyPair('RSA', 512),
-        (cb) => crypto.generateKeyPair('RSA', 1024, cb),
+        crypto.keys.generateKeyPair('RSA', 512),
-        (cb) => crypto.generateKeyPair('RSA', 1024, cb)
+        crypto.keys.generateKeyPair('RSA', 512)
-      ], (err, keys) => {
+      ])
-        expect(err).to.not.exist()
 
       k1 = keys[0]
       k2 = keys[1]
       k3 = keys[2]
-        done()
-      })
     })
 
-    it('missmatch private - public key', (done) => {
+    it('missmatch private - public key', async () => {
-      k1.public.hash((err, digest) => {
+      const digest = await k1.public.hash()
-        expect(err).to.not.exist()
+      expect(() => {
-        expect(() => new PeerId(digest, k1, k2.public))
+        new PeerId(digest, k1, k2.public) // eslint-disable-line no-new
-          .to.throw(/inconsistent arguments/)
+      }).to.throw(/inconsistent arguments/)
-        done()
-      })
     })
 
-    it('missmatch id - private - public key', (done) => {
+    it('missmatch id - private - public key', async () => {
-      k1.public.hash((err, digest) => {
+      const digest = await k1.public.hash()
-        expect(err).to.not.exist()
+      expect(() => {
-        expect(() => new PeerId(digest, k1, k3.public))
+        new PeerId(digest, k1, k3.public) // eslint-disable-line no-new
-          .to.throw(/inconsistent arguments/)
+      }).to.throw(/inconsistent arguments/)
-        done()
-      })
     })
 
     it('invalid id', () => {
-      expect(
+      expect(() => new PeerId('hello world')).to.throw(/invalid id/)
-        () => new PeerId('hello world')
-      ).to.throw(
-        /invalid id/
-      )
     })
   })
 })