chore: release version v0.12.4

* chore: revert async dep change

* chore: update async to 2.6.3

.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/Release
+build
 
 # 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
-    env: CXX=g++-4.8
-  - node_js: 6
-    env:
-      - CXX=g++-4.8
-  - node_js: stable
-    env: CXX=g++-4.8
+    - os: windows
+      cache: false
 
-# 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
 
-script:
-  - npm run lint
-  - npm test
-  - npm run coverage
-  - make test
+    - stage: test
+      name: chrome
+      addons:
+        chrome: stable
+      script:
+        - npx aegir test -t browser
+        - npx aegir test -t webworker
 
-before_script:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
+    - stage: test
+      name: firefox
+      addons:
+        firefox: latest
+      script:
+        - npx aegir test -t browser -- --browsers FirefoxHeadless
+        - npx aegir test -t webworker -- --browsers FirefoxHeadless
 
-after_success:
-  - npm run coverage-publish
-
-addons:
-  firefox: 'latest'
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test
-    packages:
-      - g++-4.8
+notifications:
+  email: false

CHANGELOG.md

@@ -0,0 +1,296 @@
+<a name="0.12.4"></a>
+## [0.12.4](https://github.com/libp2p/js-peer-id/compare/v0.12.3...v0.12.4) (2019-07-23)
+
+
+
+<a name="0.12.3"></a>
+## [0.12.3](https://github.com/libp2p/js-peer-id/compare/v0.12.2...v0.12.3) (2019-07-11)
+
+
+### Features
+
+* **peerid:** support creating from secp256k1; harmonize algo with Go ([fd07221](https://github.com/libp2p/js-peer-id/commit/fd07221))
+
+
+
+<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/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Build Status](https://travis-ci.org/libp2p/js-peer-id.svg?style=flat-square)](https://travis-ci.org/libp2p/js-peer-id)
-[![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)
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![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)
@@ -51,7 +57,7 @@ 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) => {
+PeerId.create({ bits: 1024, keyType: 'rsa' }, (err, id) => {
   if (err) { throw err }
   console.log(JSON.stringify(id.toJSON(), null, 2))
 })
@@ -122,7 +128,7 @@ The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2
 
 Generates a new Peer ID, complete with public/private keypair.
 
-- `opts: Object`: Default: `{bits: 2048}`
+- `opts: Object`: Default: `{bits: 2048, keyType: 'rsa'}`
 - `callback: Function`
 
 Calls back `callback` with `err, id`.
@@ -138,6 +144,7 @@ Creates a Peer ID from hex string representing the key's multihash.
 Creates a Peer ID from a buffer representing the key's multihash.
 
 ### `createFromB58String(str)`
+
 Creates a Peer ID from a Base58 string representing the key's multihash.
 
 ### `createFromPubKey(pubKey)`
@@ -155,8 +162,8 @@ Creates a Peer ID from a buffer containing a private key.
 ### `createFromJSON(obj)`
 
 - `obj.id: String` - The multihash encoded in `base58`
-- `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.pubKey: String` - The public key in protobuf format, encoded in `base64`
+- `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
 
 ## Export
 
@@ -192,10 +199,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,63 +1,74 @@
 {
   "name": "peer-id",
-  "version": "0.9.0",
+  "version": "0.12.4",
   "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",
-    "build": "aegir-build",
-    "test": "aegir-test",
-    "test:node": "aegir-test node",
-    "test:browser": "aegir-test browser",
-    "release": "aegir-release",
-    "release-minor": "aegir-release --type minor",
-    "release-major": "aegir-release --type major",
-    "coverage": "aegir-coverage",
-    "coverage-publish": "aegir-coverage publish"
+    "lint": "aegir lint",
+    "build": "aegir build",
+    "test": "aegir test",
+    "test:node": "aegir test -t node",
+    "test:browser": "aegir test -t browser -t webworker",
+    "release": "aegir release",
+    "release-minor": "aegir release --type minor",
+    "release-major": "aegir release --type major",
+    "coverage": "aegir coverage",
+    "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",
-    "npm": ">=3.0.0"
+    "node": ">=10.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",
-    "chai": "^4.1.0",
-    "dirty-chai": "^2.0.1",
-    "pre-commit": "^1.2.2"
+    "aegir": "^20.0.0",
+    "bundlesize": "~0.17.1",
+    "chai": "^4.2.0",
+    "dirty-chai": "^2.0.1"
   },
   "dependencies": {
-    "async": "^2.5.0",
-    "libp2p-crypto": "~0.9.4",
-    "lodash": "^4.17.4",
-    "multihashes": "~0.4.5"
+    "libp2p-crypto": "~0.16.1",
+    "async": "^2.6.3",
+    "class-is": "^1.1.0",
+    "multihashes": "~0.4.15"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/libp2p/js-peer-id.git"
   },
   "contributors": [
+    "Arve Knudsen <arve.knudsen@gmail.com>",
     "David Dias <daviddias.p@gmail.com>",
     "David Dias <mail@daviddias.me>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Hugo Dias <hugomrdias@gmail.com>",
+    "Jacob Heun <jacobheun@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

@@ -9,5 +9,6 @@ PeerId.create((err, id) => {
     throw err
   }
 
+  // eslint-disable-next-line
   console.log(JSON.stringify(id.toJSON(), null, 2))
 })

src/index.js

@@ -5,10 +5,10 @@
 '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 Buffer = require('safe-buffer').Buffer
+const withIs = require('class-is')
 
 class PeerId {
   constructor (id, privKey, pubKey) {
@@ -57,20 +57,30 @@ class PeerId {
   // Return the protobuf version of the public key, matching go ipfs formatting
   marshalPubKey () {
     if (this.pubKey) {
-      return crypto.keys.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.keys.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
@@ -123,7 +133,30 @@ class PeerId {
   }
 }
 
-exports = module.exports = PeerId
+const PeerIdWithIs = withIs(PeerId, { className: 'PeerId', symbolName: '@libp2p/js-peer-id/PeerId' })
+
+exports = module.exports = PeerIdWithIs
+
+const computeDigest = (pubKey, cb) => {
+  if (pubKey.bytes.length <= 42) {
+    const digest = mh.encode(pubKey.bytes, 'identity')
+    cb(null, digest)
+  } else {
+    pubKey.hash((err, digest) => {
+      cb(err, digest)
+    })
+  }
+}
+
+const computePeerId = (privKey, pubKey, cb) => {
+  computeDigest(pubKey, (err, digest) => {
+    if (err != null) {
+      cb(err)
+    } else {
+      cb(null, new PeerIdWithIs(digest, privKey, pubKey))
+    }
+  })
+}
 
 // generation
 exports.create = function (opts, callback) {
@@ -133,31 +166,27 @@ exports.create = function (opts, callback) {
   }
   opts = opts || {}
   opts.bits = opts.bits || 2048
+  opts.keyType = opts.keyType || 'RSA'
 
-  waterfall([
-    (cb) => crypto.keys.generateKeyPair('RSA', opts.bits, cb),
-    (privKey, cb) => privKey.public.hash((err, digest) => {
-      cb(err, digest, privKey)
-    })
-  ], (err, digest, privKey) => {
-    if (err) {
-      return callback(err)
+  cryptoKeys.generateKeyPair(opts.keyType, opts.bits, (err, privKey) => {
+    if (err != null) {
+      callback(err)
+    } else {
+      computePeerId(privKey, privKey.public, callback)
     }
-
-    callback(null, new PeerId(digest, privKey))
   })
 }
 
 exports.createFromHexString = function (str) {
-  return new PeerId(mh.fromHexString(str))
+  return new PeerIdWithIs(mh.fromHexString(str))
 }
 
 exports.createFromBytes = function (buf) {
-  return new PeerId(buf)
+  return new PeerIdWithIs(buf)
 }
 
 exports.createFromB58String = function (str) {
-  return new PeerId(mh.fromB58String(str))
+  return new PeerIdWithIs(mh.fromB58String(str))
 }
 
 // Public Key input will be a buffer
@@ -166,44 +195,48 @@ exports.createFromPubKey = function (key, callback) {
     throw new Error('callback is required')
   }
 
-  let buf = key
-  if (typeof buf === 'string') {
-    buf = Buffer.from(key, 'base64')
-  }
+  let pubKey
 
-  const pubKey = crypto.keys.unmarshalPublicKey(buf)
-
-  pubKey.hash((err, digest) => {
-    if (err) {
-      return callback(err)
+  try {
+    let buf = key
+    if (typeof buf === 'string') {
+      buf = Buffer.from(key, 'base64')
     }
 
-    callback(null, new PeerId(digest, null, pubKey))
-  })
+    if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
+
+    pubKey = cryptoKeys.unmarshalPublicKey(buf)
+  } catch (err) {
+    return callback(err)
+  }
+
+  computePeerId(null, pubKey, callback)
 }
 
 // Private key input will be a string
 exports.createFromPrivKey = function (key, callback) {
-  let buf = key
-  if (typeof buf === 'string') {
-    buf = Buffer.from(key, 'base64')
-  }
-
   if (typeof callback !== 'function') {
     throw new Error('callback is required')
   }
 
-  waterfall([
-    (cb) => crypto.keys.unmarshalPrivateKey(buf, cb),
-    (privKey, cb) => privKey.public.hash((err, digest) => {
-      cb(err, digest, privKey)
-    })
-  ], (err, digest, privKey) => {
-    if (err) {
-      return callback(err)
+  let buf = key
+
+  try {
+    if (typeof buf === 'string') {
+      buf = Buffer.from(key, 'base64')
     }
 
-    callback(null, new PeerId(digest, privKey))
+    if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
+  } catch (err) {
+    return callback(err)
+  }
+
+  cryptoKeys.unmarshalPrivateKey(buf, (err, privKey) => {
+    if (err != null) {
+      callback(err)
+    } else {
+      computePeerId(privKey, privKey.public, callback)
+    }
   })
 }
 
@@ -212,44 +245,56 @@ exports.createFromJSON = function (obj, callback) {
     throw new Error('callback is required')
   }
 
-  const id = mh.fromB58String(obj.id)
-  const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
-  const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
-  const pub = rawPubKey && crypto.keys.unmarshalPublicKey(rawPubKey)
+  let id
+  let rawPrivKey
+  let rawPubKey
+  let pub
 
-  if (rawPrivKey) {
-    waterfall([
-      (cb) => crypto.keys.unmarshalPrivateKey(rawPrivKey, cb),
-      (priv, cb) => priv.public.hash((err, digest) => {
-        cb(err, digest, priv)
-      }),
-      (privDigest, priv, cb) => {
-        if (pub) {
-          pub.hash((err, pubDigest) => {
-            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'))
-      }
-
-      if (id && !privDigest.equals(id)) {
-        return callback(new Error('Id and private key do not match'))
-      }
-
-      callback(null, new PeerId(id, priv, pub))
-    })
-  } else {
-    callback(null, new PeerId(id, null, pub))
+  try {
+    id = mh.fromB58String(obj.id)
+    rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
+    rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
+    pub = rawPubKey && cryptoKeys.unmarshalPublicKey(rawPubKey)
+  } catch (err) {
+    return callback(err)
   }
+
+  if (!rawPrivKey) {
+    callback(null, new PeerIdWithIs(id, null, pub))
+    return
+  }
+
+  waterfall([
+    (cb) => cryptoKeys.unmarshalPrivateKey(rawPrivKey, cb),
+    (priv, cb) => {
+      computeDigest(priv.public, (err, digest) => {
+        cb(err, digest, priv)
+      })
+    },
+    (privDigest, priv, cb) => {
+      if (pub) {
+        computeDigest(pub, (err, pubDigest) => {
+          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'))
+    }
+
+    if (id && !privDigest.equals(id)) {
+      return callback(new Error('Id and private key do not match'))
+    }
+
+    callback(null, new PeerIdWithIs(id, priv, pub))
+  })
 }
 
 exports.isPeerId = function (peerId) {

test/peer-id.spec.js

@@ -9,10 +9,12 @@ const expect = chai.expect
 const crypto = require('libp2p-crypto')
 const mh = require('multihashes')
 const parallel = require('async/parallel')
-const Buffer = require('safe-buffer').Buffer
+const waterfall = require('async/waterfall')
 
 const PeerId = require('../src')
 
+const util = require('util')
+
 const testId = require('./fixtures/sample-id')
 const testIdHex = testId.id
 const testIdBytes = mh.fromHexString(testId.id)
@@ -20,21 +22,36 @@ 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) => {
-    PeerId.create((err, id) => {
+    PeerId.create(testOpts, (err, id) => {
       expect(err).to.not.exist()
       expect(id.toB58String().length).to.equal(46)
       done()
     })
   })
 
+  it('can be created for a Secp256k1 key', (done) => {
+    PeerId.create({ keyType: 'secp256k1', bits: 256 }, (err, id) => {
+      const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
+      expect(err).to.not.exist()
+      expect(id.toB58String()).to.equal(expB58)
+      done()
+    })
+  })
+
   it('isPeerId', (done) => {
-    PeerId.create((err, id) => {
+    PeerId.create(testOpts, (err, id) => {
       expect(err).to.not.exist()
       expect(PeerId.isPeerId(id)).to.equal(true)
       expect(PeerId.isPeerId('aaa')).to.equal(false)
@@ -43,8 +60,9 @@ describe('PeerId', () => {
     })
   })
 
-  it('throws on changing the id', (done) => {
-    PeerId.create((err, id) => {
+  it('throws on changing the id', function (done) {
+    this.timeout(10000)
+    PeerId.create(testOpts, (err, id) => {
       expect(err).to.not.exist()
       expect(id.toB58String().length).to.equal(46)
       expect(() => {
@@ -77,6 +95,22 @@ describe('PeerId', () => {
     })
   })
 
+  it('can be created from a Secp256k1 public key', (done) => {
+    waterfall([
+      (cb) => {
+        crypto.keys.generateKeyPair('secp256k1', 256, cb)
+      },
+      (privKey, cb) => {
+        PeerId.createFromPubKey(privKey.public.bytes, cb)
+      }
+    ], (err, id) => {
+      expect(err).to.not.exist()
+      const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
+      expect(id.toB58String()).to.equal(expB58)
+      done()
+    })
+  })
+
   it('Recreate from a Private Key', (done) => {
     PeerId.createFromPrivKey(testId.privKey, (err, id) => {
       expect(err).to.not.exist()
@@ -86,13 +120,30 @@ describe('PeerId', () => {
       PeerId.createFromPrivKey(encoded, (err, id2) => {
         expect(err).to.not.exist()
         expect(testIdB58String).to.equal(id2.toB58String())
+        expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
         done()
       })
     })
   })
 
+  it('can be created from a Secp256k1 private key', (done) => {
+    waterfall([
+      (cb) => {
+        crypto.keys.generateKeyPair('secp256k1', 256, cb)
+      },
+      (privKey, cb) => {
+        PeerId.createFromPrivKey(privKey.bytes, cb)
+      }
+    ], (err, id) => {
+      expect(err).to.not.exist()
+      const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
+      expect(id.toB58String()).to.equal(expB58)
+      done()
+    })
+  })
+
   it('Compare generated ID with one created from PubKey', (done) => {
-    PeerId.create((err, id1) => {
+    PeerId.create(testOpts, (err, id1) => {
       expect(err).to.not.exist()
 
       PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
@@ -103,10 +154,20 @@ describe('PeerId', () => {
     })
   })
 
-  it('Non-default # of bits', (done) => {
-    PeerId.create({ bits: 1024 }, (err, shortId) => {
+  it('Works with default options', function (done) {
+    this.timeout(10000)
+    PeerId.create((err, id) => {
       expect(err).to.not.exist()
-      PeerId.create({ bits: 4096 }, (err, longId) => {
+      expect(id.toB58String().length).to.equal(46)
+      done()
+    })
+  })
+
+  it('Non-default # of bits', function (done) {
+    this.timeout(1000 * 60)
+    PeerId.create(testOpts, (err, shortId) => {
+      expect(err).to.not.exist()
+      PeerId.create({ bits: 1024 }, (err, longId) => {
         expect(err).to.not.exist()
         expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
         done()
@@ -115,11 +176,12 @@ describe('PeerId', () => {
   })
 
   it('Pretty printing', (done) => {
-    PeerId.create((err, id1) => {
+    PeerId.create(testOpts, (err, id1) => {
       expect(err).to.not.exist()
-      PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
+      PeerId.createFromPrivKey(id1.toJSON().privKey, (err, id2) => {
         expect(err).to.not.exist()
         expect(id1.toPrint()).to.be.eql(id2.toPrint())
+        expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>')
         done()
       })
     })
@@ -132,8 +194,8 @@ describe('PeerId', () => {
 
   it('isEqual', (done) => {
     parallel([
-      (cb) => PeerId.create(cb),
-      (cb) => PeerId.create(cb)
+      (cb) => PeerId.create(testOpts, cb),
+      (cb) => PeerId.create(testOpts, cb)
     ], (err, ids) => {
       expect(err).to.not.exist()
       expect(ids[0].isEqual(ids[0])).to.equal(true)
@@ -146,7 +208,7 @@ describe('PeerId', () => {
 
   describe('fromJSON', () => {
     it('full node', (done) => {
-      PeerId.create({ bits: 1024 }, (err, id) => {
+      PeerId.create(testOpts, (err, id) => {
         expect(err).to.not.exist()
 
         PeerId.createFromJSON(id.toJSON(), (err, other) => {
@@ -191,7 +253,7 @@ describe('PeerId', () => {
   })
 
   it('set privKey (valid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.privKey = peerId._privKey
       peerId.isValid(done)
@@ -199,7 +261,7 @@ describe('PeerId', () => {
   })
 
   it('set pubKey (valid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.pubKey = peerId._pubKey
       peerId.isValid(done)
@@ -207,7 +269,7 @@ describe('PeerId', () => {
   })
 
   it('set privKey (invalid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.privKey = Buffer.from('bufff')
       peerId.isValid((err) => {
@@ -218,7 +280,7 @@ describe('PeerId', () => {
   })
 
   it('set pubKey (invalid)', (done) => {
-    PeerId.create((err, peerId) => {
+    PeerId.create(testOpts, (err, peerId) => {
       expect(err).to.not.exist()
       peerId.pubKey = Buffer.from('buffff')
       peerId.isValid((err) => {
@@ -228,6 +290,24 @@ describe('PeerId', () => {
     })
   })
 
+  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']
+
+    garbage.forEach(garbage => {
+      fncs.forEach(fnc => {
+        it(fnc + '(' + util.inspect(garbage) + ')', cb => {
+          PeerId[fnc](garbage, (err, res) => {
+            expect(err).to.exist()
+            expect(res).to.not.exist()
+            cb()
+          })
+        })
+      })
+    })
+  })
+
   describe('throws on inconsistent data', () => {
     let k1
     let k2
@@ -235,9 +315,9 @@ describe('PeerId', () => {
 
     before((done) => {
       parallel([
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb)
+        (cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
+        (cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
+        (cb) => crypto.keys.generateKeyPair('RSA', 512, cb)
       ], (err, keys) => {
         expect(err).to.not.exist()