chore: release version v0.13.9

Tell Typescript that `isPeerId(id)` returns true if, and only if, `id` is of type `PeerId`.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates

.gitignore

@@ -1,3 +1,4 @@
+docs
 **/node_modules/
 **/*.log
 test/repo-tests*
@@ -32,6 +33,7 @@ build
 # 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
@@ -40,3 +42,4 @@ 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,32 +1,45 @@
-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: 6
+    - os: windows
-    env: CXX=g++-4.8
+      cache: false
-  - node_js: 8
-    env: CXX=g++-4.8
-    #  - node_js: stable
-    #    env: CXX=g++-4.8
 
-script:
+    - stage: check
-  - npm run lint
+      script:
-  - npm run test
+        - npx aegir dep-check
-  - npm run coverage
+        - npm run lint
-  - make test
 
-before_script:
+    - stage: test
-  - export DISPLAY=:99.0
+      name: chrome
-  - sh -e /etc/init.d/xvfb start
+      addons:
+        chrome: stable
+      script:
+        - npx aegir test -t browser
+        - npx aegir test -t webworker
 
-after_success:
+    - stage: test
-  - npm run coverage-publish
+      name: firefox
+      addons:
+        firefox: latest
+      script:
+        - npx aegir test -t browser -- --browsers FirefoxHeadless
+        - npx aegir test -t webworker -- --browsers FirefoxHeadless
 
-addons:
+notifications:
-  firefox: 'latest'
+  email: false
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test
-    packages:
-      - g++-4.8

CHANGELOG.md

@@ -0,0 +1,391 @@
+<a name="0.13.9"></a>
+## [0.13.9](https://github.com/libp2p/js-peer-id/compare/v0.13.8...v0.13.9) (2020-02-19)
+
+
+
+<a name="0.13.8"></a>
+## [0.13.8](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.8) (2020-02-18)
+
+
+### Bug Fixes
+
+* remove use of assert module ([#117](https://github.com/libp2p/js-peer-id/issues/117)) ([f44645e](https://github.com/libp2p/js-peer-id/commit/f44645e))
+
+
+### Features
+
+* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae))
+
+
+
+<a name="0.13.7"></a>
+## [0.13.7](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.7) (2020-01-27)
+
+
+### Features
+
+* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae))
+
+
+
+<a name="0.13.6"></a>
+## [0.13.6](https://github.com/libp2p/js-peer-id/compare/v0.13.5...v0.13.6) (2019-12-18)
+
+
+### Bug Fixes
+
+* catch errors thrown by multihash decode ([#109](https://github.com/libp2p/js-peer-id/issues/109)) ([65e0b74](https://github.com/libp2p/js-peer-id/commit/65e0b74))
+
+
+
+<a name="0.13.5"></a>
+## [0.13.5](https://github.com/libp2p/js-peer-id/compare/v0.13.4...v0.13.5) (2019-11-12)
+
+
+### Features
+
+* deprecate isEqual in favor of equals ([#107](https://github.com/libp2p/js-peer-id/issues/107)) ([bbf0416](https://github.com/libp2p/js-peer-id/commit/bbf0416))
+
+
+
+<a name="0.13.4"></a>
+## [0.13.4](https://github.com/libp2p/js-peer-id/compare/v0.13.3...v0.13.4) (2019-11-04)
+
+
+### Bug Fixes
+
+* bang in bin.js ([#106](https://github.com/libp2p/js-peer-id/issues/106)) ([11d4ec1](https://github.com/libp2p/js-peer-id/commit/11d4ec1))
+
+
+### Features
+
+* support Peer ID represented as CID ([#105](https://github.com/libp2p/js-peer-id/issues/105)) ([544ca7d](https://github.com/libp2p/js-peer-id/commit/544ca7d))
+
+
+
+<a name="0.13.3"></a>
+## [0.13.3](https://github.com/libp2p/js-peer-id/compare/v0.13.2...v0.13.3) (2019-09-25)
+
+
+### Features
+
+* allow nested PeerIds to support pubKey function when using identity encoding ([#101](https://github.com/libp2p/js-peer-id/issues/101)) ([f39fb24](https://github.com/libp2p/js-peer-id/commit/f39fb24))
+
+
+
+<a name="0.13.2"></a>
+## [0.13.2](https://github.com/libp2p/js-peer-id/compare/v0.13.1...v0.13.2) (2019-07-12)
+
+
+### Features
+
+* add compact protobuf format ([#76](https://github.com/libp2p/js-peer-id/issues/76)) ([7686418](https://github.com/libp2p/js-peer-id/commit/7686418))
+
+
+
+<a name="0.13.1"></a>
+## [0.13.1](https://github.com/libp2p/js-peer-id/compare/v0.13.0...v0.13.1) (2019-07-11)
+
+
+### Features
+
+* **peerid:** support creating from secp256k1; harmonize algo with Go ([#95](https://github.com/libp2p/js-peer-id/issues/95)) ([17440a3](https://github.com/libp2p/js-peer-id/commit/17440a3))
+
+
+
+<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,25 @@
 # 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%3D6.0.0-orange.svg?style=flat-square)
 
 > [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
 
+## Lead Maintainer
+
+[Vasco Santos](https://github.com/vasco-santos)
+
+## Table of Contents
+
+- [peer-id](#peer-id)
+  - [Lead Maintainer](#lead-maintainer)
+  - [Table of Contents](#table-of-contents)
 - [Description](#description)
 - [Example](#example)
 - [Installation](#installation)
@@ -22,20 +31,27 @@
 - [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)
+    - [`createFromCID(cid)`](#createfromcidcid)
     - [`createFromB58String(str)`](#createfromb58stringstr)
     - [`createFromPubKey(pubKey)`](#createfrompubkeypubkey)
     - [`createFromPrivKey(privKey)`](#createfromprivkeyprivkey)
     - [`createFromJSON(obj)`](#createfromjsonobj)
+    - [`createFromProtobuf(buf)`](#createfromprotobufbuf)
   - [Export](#export)
     - [`toHexString()`](#tohexstring)
     - [`toBytes()`](#tobytes)
+    - [`toString()`](#tostring)
     - [`toB58String()`](#tob58string)
     - [`toJSON()`](#tojson)
+    - [`marshal(excludePrivateKey)`](#marshalexcludeprivatekey)
+    - [`marshalPubKey()`](#marshalpubkey)
     - [`toPrint()`](#toprint)
+    - [`equals(id)`](#equalsid)
+    - [`isEqual(id)`](#isequalid)
 - [License](#license)
 
 # Description
@@ -51,11 +67,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, keyType: 'rsa' })
-  if (err) { throw err }
+console.log(JSON.stringify(id.toJSON(), null, 2))
-  console.log(JSON.stringify(id.toJSON(), null, 2))
-})
 ```
+
 ```bash
 {
   "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
@@ -112,20 +127,19 @@ const PeerId = require('peer-id')
 
 ### `new PeerId(id[, privKey, pubKey])`
 
-- `id: Buffer` - The multihash of the publick key as `Buffer`
+- `id: Buffer` - The multihash of the public key as `Buffer`
 - `privKey: RsaPrivateKey` - The private key
 - `pubKey: RsaPublicKey` - The public key
 
 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}`
+- `opts: Object`: Default: `{bits: 2048, keyType: 'rsa'}`
-- `callback: Function`
 
-Calls back `callback` with `err, id`.
+Returns `Promise<PeerId>`.
 
 ## Import
 
@@ -133,30 +147,55 @@ 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`.
+
+### `createFromCID(cid)`
+
+- `cid: CID|String|Buffer` - The multihash encoded as [CID](https://github.com/ipld/js-cid) (object, `String` or `Buffer`)
+
+Creates a Peer ID from a CID representation of the key's multihash ([RFC 0001](https://github.com/libp2p/specs/blob/master/RFC/0001-text-peerid-cid.md)).
+
+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>`.
+
+### `createFromProtobuf(buf)`
+
+`buf` is a protocol-buffers encoded PeerId (see `marshal()`)
 
 ## Export
 
@@ -176,9 +215,18 @@ Returns the Peer ID's `id` as a buffer.
 <Buffer 12 20 d6 24 39 98 f2 fc 56 34 3a d7 ed 03 42 ab 78 86 a4 eb 18 d7 36 f1 b6 7d 44 b3 7f cc 81 e0 f3 9f>
 ```
 
+
+### `toString()`
+
+Returns the Peer ID's `id` as a self-describing CIDv1 in Base32 ([RFC 0001](https://github.com/libp2p/specs/blob/master/RFC/0001-text-peerid-cid.md))
+
+```
+bafzbeigweq4zr4x4ky2dvv7nanbkw6egutvrrvzw6g3h2rftp7gidyhtt4
+```
+
 ### `toB58String()`
 
-Returns the Peer ID's `id` as a base58 string.
+Returns the Peer ID's `id` as a base58 string (multihash/CIDv0).
 
 ```
 QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
@@ -192,12 +240,38 @@ 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'
 
+### `marshal(excludePrivateKey)`
+
+Returns a protocol-buffers encoded version of the id, public key and, if `excludePrivateKey` is not set, the private key.
+
+### `marshalPubKey()`
+
+Returns a protobuf of just the public key, compatible with `libp2p-crypto` (unlike `marshal` above).
+
+For example:
+```js
+const crypto = require('libp2p-crypto')
+
+PeerId.create({ bits: 256, keyType: 'ed25519' }).then( pid => {
+  let pk = crypto.keys.unmarshalPublicKey(pid.marshalPubKey())
+  // your code here
+}
+```
 
 ### `toPrint()`
 
-Alias for `.toJSON()`.
+Returns the Peer ID as a printable string without the `Qm` prefix.
+
+Example: `<peer.ID xxxxxx>`
+
+### `equals(id)`
+
+Returns `true` if the given PeerId is equal to the current instance.
+
+- `id` can be a PeerId or a Buffer containing the id
 
 ### `isEqual(id)`
+**Deprecation Notice**: Use [`equals`](#equalsid), `isEqual` will be removed in 0.14.0.
 
 - `id` can be a PeerId or a Buffer containing the 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,88 @@
 {
   "name": "peer-id",
-  "version": "0.10.0",
+  "version": "0.13.9",
   "description": "IPFS Peer Id implementation in Node.js",
+  "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "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",
+    "test:types": "npx tsc",
-    "release-minor": "aegir-release --type minor",
+    "release": "aegir release",
-    "release-major": "aegir-release --type major",
+    "release-minor": "aegir release --type minor",
-    "coverage": "aegir-coverage",
+    "release-major": "aegir release --type major",
-    "coverage-publish": "aegir-coverage publish"
+    "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": ">=6.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",
+    "@types/chai": "^4.2.7",
-    "chai": "^4.1.2",
+    "@types/dirty-chai": "^2.0.2",
-    "dirty-chai": "^2.0.1",
+    "@types/mocha": "^5.2.7",
-    "pre-commit": "^1.2.2"
+    "aegir": "^20.0.0",
+    "bundlesize": "~0.18.0",
+    "chai": "^4.2.0",
+    "dirty-chai": "^2.0.1"
   },
   "dependencies": {
-    "async": "^2.5.0",
+    "cids": "^0.7.3",
-    "libp2p-crypto": "~0.9.4",
+    "class-is": "^1.1.0",
-    "lodash": "^4.17.4",
+    "libp2p-crypto": "~0.17.2",
-    "multihashes": "~0.4.9"
+    "multihashes": "~0.4.15",
+    "protons": "^1.0.1"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/libp2p/js-peer-id.git"
   },
   "contributors": [
+    "Alex Potsides <alex@achingbrain.net>",
+    "Arve Knudsen <arve.knudsen@gmail.com>",
+    "Carson Farmer <carson.farmer@gmail.com>",
+    "Christian Paul <info@jaller.de>",
     "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>",
+    "Jacob Heun <jacobheun@gmail.com>",
+    "Maciej Krüger <mkg20001@gmail.com>",
+    "Marcin Rataj <lidel@lidel.org>",
+    "Michael Garvin <gar+gh@danger.computer>",
+    "Nate Foss <npfoss@gmail.com>",
+    "Pedro Teixeira <i@pgte.me>",
     "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
+    "Richard Schneider <makaretu@gmail.com>",
+    "Robert Kiel <robert.kiel@validitylabs.org>",
     "Stephen Whitmore <stephen.whitmore@gmail.com>",
+    "Topper Bowers <topper@quorumcontrol.com>",
+    "Vasco Santos <vasco.santos@moxy.studio>",
+    "Vasco Santos <vasco.santos@ua.pt>",
+    "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

@@ -1,13 +1,12 @@
-#!/usr/local/bin/node
+#!/usr/bin/env node
 
 'use strict'
 
 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.d.ts

@@ -0,0 +1,188 @@
+import crypto, { PrivateKey, PublicKey, KeyType } from "libp2p-crypto";
+import CID from 'cids'
+
+declare namespace PeerId {
+  /**
+   * Options for PeerId creation.
+   */
+  type CreateOptions = {
+    /**
+     * The number of bits to use.
+     */
+    bits?: number;
+    /**
+     * The type of key to use.
+     */
+    keyType?: KeyType;
+  };
+
+  /**
+   * PeerId JSON format.
+   */
+  type JSONPeerId = {
+    /**
+     * String representation of PeerId.
+     */
+    id: string;
+    /**
+     * Public key.
+     */
+    pubKey?: string;
+    /**
+     * Private key.
+     */
+    privKey: string;
+  };
+
+  /**
+   * Checks if a value is an instance of PeerId.
+   * @param id The value to check.
+   */
+  function isPeerId(id: any): id is PeerId
+
+  /**
+   * Create a new PeerId.
+   * @param opts Options.
+   */
+  function create(opts?: PeerId.CreateOptions): Promise<PeerId>;
+
+  /**
+   * Create PeerId from hex string.
+   * @param str The input hex string.
+   */
+  function createFromHexString(str: string): PeerId;
+  
+  /**
+   * Create PeerId from raw bytes.
+   * @param buf The raw bytes.
+   */
+  function createFromBytes(buf: Buffer): PeerId;
+
+  /**
+   * Create PeerId from base58-encoded string.
+   * @param str The base58-encoded string.
+   */
+  function createFromB58String(str: string): PeerId;
+  
+  /**
+   * Create PeerId from CID.
+   * @param cid The CID.
+   */
+  function createFromCID(cid: CID | Buffer | string | object): PeerId;
+
+  /**
+   * Create PeerId from public key.
+   * @param key Public key, as Buffer or base64-encoded string.
+   */
+  function createFromPubKey(key: Buffer | string): Promise<PeerId>;
+
+  /**
+   * Create PeerId from private key.
+   * @param key Private key, as Buffer or base64-encoded string.
+   */
+  function createFromPrivKey(key: Buffer | string): Promise<PeerId>;
+
+  /**
+   * Create PeerId from PeerId JSON formatted object.
+   * @see {@link PeerId#toJSON}
+   * @param json PeerId in JSON format.
+   */
+  function createFromJSON(json: JSONPeerId): Promise<PeerId>;
+
+  /**
+   * Create PeerId from Protobuf bytes.
+   * @param buf Protobuf bytes, as Buffer or hex-encoded string.
+   */
+  function createFromProtobuf(buf: Buffer | string): Promise<PeerId>;
+}
+
+/**
+ * PeerId is an object representation of a peer identifier.
+ */
+declare class PeerId {
+  constructor(id: Buffer | string, privKey?: PrivateKey, pubKey?: PublicKey);
+
+  /**
+   * Raw id.
+   */
+  readonly id: Buffer;
+
+  /**
+   * Private key.
+   */
+  privKey: PrivateKey;
+
+  /**
+   * Public key.
+   */
+  pubKey: PublicKey;
+
+  /**
+   * Return the protobuf version of the public key, matching go ipfs formatting.
+   */
+  marshalPubKey(): Buffer;
+
+  /**
+   * Return the protobuf version of the private key, matching go ipfs formatting.
+   */
+  marshalPrivKey(): Buffer;
+
+  /**
+   * Return the protobuf version of the peer-id.
+   * @param excludePriv Whether to exclude the private key information from the output.
+   */
+  marshal(excludePriv?: boolean): Buffer;
+
+  /**
+   * String representation.
+   */
+  toPrint(): string;
+
+  /**
+   * Return the jsonified version of the key.
+   * Matches the formatting of go-ipfs for its config file.
+   * @see {@link PeerId.createFromJSON}
+   */
+  toJSON(): PeerId.JSONPeerId;
+
+  /**
+   * Encode to hex.
+   */
+  toHexString(): string;
+
+  /**
+   * Return raw id bytes.
+   */
+  toBytes(): Buffer;
+
+  /**
+   * Encode to base58 string.
+   */
+  toB58String(): string;
+
+  /**
+   * Return self-describing string representation.
+   * Uses default format from RFC 0001: https://github.com/libp2p/specs/pull/209
+   */
+  toString(): string;
+
+  /**
+   * Checks the equality of `this` peer against a given PeerId.
+   * @param id The other PeerId.
+   */
+  equals(id: PeerId | Buffer): boolean;
+
+  /**
+   * Checks the equality of `this` peer against a given PeerId.
+   * @deprecated Use {.equals}
+   * @param id The other PeerId.
+   */
+  isEqual(id: PeerId | Buffer): boolean;
+
+  /**
+   * Check if this PeerId instance is valid (privKey -> pubKey -> Id)
+   */
+  isValid(): boolean;
+}
+
+export = PeerId;

src/index.js

@@ -5,17 +5,19 @@
 'use strict'
 
 const mh = require('multihashes')
-const crypto = require('libp2p-crypto')
+const CID = require('cids')
-const assert = require('assert')
+const cryptoKeys = require('libp2p-crypto/src/keys')
-const waterfall = require('async/waterfall')
+const withIs = require('class-is')
-const Buffer = require('safe-buffer').Buffer
+const { PeerIdProto } = require('./proto')
 
 class PeerId {
   constructor (id, privKey, pubKey) {
-    assert(Buffer.isBuffer(id), 'invalid id provided')
+    if (!Buffer.isBuffer(id)) {
+      throw new Error('invalid id provided')
+    }
 
-    if (privKey && pubKey) {
+    if (privKey && pubKey && !privKey.public.bytes.equals(pubKey.bytes)) {
-      assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
+      throw new Error('inconsistent arguments')
     }
 
     this._id = id
@@ -48,6 +50,18 @@ class PeerId {
     if (this._privKey) {
       return this._privKey.public
     }
+
+    try {
+      const decoded = mh.decode(this.id)
+
+      if (decoded.name === 'identity') {
+        this._pubKey = cryptoKeys.unmarshalPublicKey(decoded.digest)
+      }
+    } catch (_) {
+      // Ignore, there is no valid public key
+    }
+
+    return this._pubKey
   }
 
   set pubKey (pubKey) {
@@ -57,20 +71,39 @@ 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
+  // Return the protobuf version of the peer-id
+  marshal (excludePriv) {
+    return PeerIdProto.encode({
+      id: this.toBytes(),
+      pubKey: this.marshalPubKey(),
+      privKey: excludePriv ? null : this.marshalPrivKey()
+    })
+  }
+
   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
@@ -96,7 +129,22 @@ class PeerId {
     return this._idB58String
   }
 
-  isEqual (id) {
+  // return self-describing String representation
+  // in default format from RFC 0001: https://github.com/libp2p/specs/pull/209
+  toString () {
+    if (!this._idCIDString) {
+      const cid = new CID(1, 'libp2p-key', this.id, 'base32')
+      this._idCIDString = cid.toBaseEncodedString('base32')
+    }
+    return this._idCIDString
+  }
+
+  /**
+   * Checks the equality of `this` peer against a given PeerId.
+   * @param {Buffer|PeerId} id
+   * @returns {boolean}
+   */
+  equals (id) {
     if (Buffer.isBuffer(id)) {
       return this.id.equals(id)
     } else if (id.id) {
@@ -106,153 +154,188 @@ class PeerId {
     }
   }
 
+  /**
+   * Checks the equality of `this` peer against a given PeerId.
+   * @deprecated Use `.equals`
+   * @param {Buffer|PeerId} id
+   * @returns {boolean}
+   */
+  isEqual (id) {
+    return this.equals(id)
+  }
+
   /*
    * 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
+
+const computeDigest = (pubKey) => {
+  if (pubKey.bytes.length <= 42) {
+    return mh.encode(pubKey.bytes, 'identity')
+  } else {
+    return pubKey.hash()
+  }
+}
+
+const computePeerId = async (privKey, pubKey) => {
+  const digest = await computeDigest(pubKey)
+  return new PeerIdWithIs(digest, privKey, pubKey)
+}
 
 // generation
-exports.create = function (opts, callback) {
+exports.create = async (opts) => {
-  if (typeof opts === 'function') {
-    callback = opts
-    opts = {}
-  }
   opts = opts || {}
   opts.bits = opts.bits || 2048
+  opts.keyType = opts.keyType || 'RSA'
 
-  waterfall([
+  const key = await cryptoKeys.generateKeyPair(opts.keyType, opts.bits)
-    (cb) => crypto.keys.generateKeyPair('RSA', opts.bits, cb),
+  return computePeerId(key, key.public)
-    (privKey, cb) => privKey.public.hash((err, digest) => {
-      cb(err, digest, privKey)
-    })
-  ], (err, digest, privKey) => {
-    if (err) {
-      return callback(err)
-    }
-
-    callback(null, new PeerId(digest, privKey))
-  })
 }
 
-exports.createFromHexString = function (str) {
+exports.createFromHexString = (str) => {
-  return new PeerId(mh.fromHexString(str))
+  return new PeerIdWithIs(mh.fromHexString(str))
 }
 
-exports.createFromBytes = function (buf) {
+exports.createFromBytes = (buf) => {
-  return new PeerId(buf)
+  return new PeerIdWithIs(buf)
 }
 
-exports.createFromB58String = function (str) {
+exports.createFromB58String = (str) => {
-  return new PeerId(mh.fromB58String(str))
+  return exports.createFromCID(str) // B58String is CIDv0
+}
+
+const validMulticodec = (cid) => {
+  // supported: 'libp2p-key' (CIDv1) and 'dag-pb' (CIDv0 converted to CIDv1)
+  return cid.codec === 'libp2p-key' || cid.codec === 'dag-pb'
+}
+
+exports.createFromCID = (cid) => {
+  cid = CID.isCID(cid) ? cid : new CID(cid)
+  if (!validMulticodec(cid)) throw new Error('Supplied PeerID CID has invalid multicodec: ' + cid.codec)
+  return new PeerIdWithIs(cid.multihash)
 }
 
 // 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 = Buffer.from(key, 'base64')
   }
 
-  const pubKey = crypto.keys.unmarshalPublicKey(buf)
+  if (!Buffer.isBuffer(buf)) {
+    throw new Error('Supplied key is neither a base64 string nor a buffer')
+  }
 
-  pubKey.hash((err, digest) => {
+  const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
-    if (err) {
+  return computePeerId(null, pubKey)
-      return callback(err)
-    }
-
-    callback(null, new PeerId(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 = 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.keys.unmarshalPrivateKey(buf, cb),
+  return computePeerId(privKey, privKey.public)
-    (privKey, cb) => privKey.public.hash((err, digest) => {
-      cb(err, digest, privKey)
-    })
-  ], (err, digest, privKey) => {
-    if (err) {
-      return callback(err)
-    }
-
-    callback(null, new PeerId(digest, privKey))
-  })
 }
 
-exports.createFromJSON = function (obj, callback) {
+exports.createFromJSON = async (obj) => {
-  if (typeof callback !== 'function') {
-    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)
+  const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
 
-  if (rawPrivKey) {
+  if (!rawPrivKey) {
-    waterfall([
+    return new PeerIdWithIs(id, null, pub)
-      (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))
   }
+
+  const privKey = await cryptoKeys.unmarshalPrivateKey(rawPrivKey)
+  const privDigest = await computeDigest(privKey.public)
+
+  let pubDigest
+
+  if (pub) {
+    pubDigest = await computeDigest(pub)
+  }
+
+  if (pub && !privDigest.equals(pubDigest)) {
+    throw new Error('Public and private key do not match')
+  }
+
+  if (id && !privDigest.equals(id)) {
+    throw new Error('Id and private key do not match')
+  }
+
+  return new PeerIdWithIs(id, privKey, pub)
 }
 
-exports.isPeerId = function (peerId) {
+exports.createFromProtobuf = async (buf) => {
+  if (typeof buf === 'string') {
+    buf = Buffer.from(buf, 'hex')
+  }
+
+  let { id, privKey, pubKey } = PeerIdProto.decode(buf)
+
+  privKey = privKey ? await cryptoKeys.unmarshalPrivateKey(privKey) : false
+  pubKey = pubKey ? await cryptoKeys.unmarshalPublicKey(pubKey) : false
+
+  let pubDigest
+  let privDigest
+
+  if (privKey) {
+    privDigest = await computeDigest(privKey.public)
+  }
+
+  if (pubKey) {
+    pubDigest = await computeDigest(pubKey)
+  }
+
+  if (privKey) {
+    if (pubKey) {
+      if (!privDigest.equals(pubDigest)) {
+        throw new Error('Public and private key do not match')
+      }
+    }
+    return new PeerIdWithIs(privDigest, privKey, privKey.public)
+  }
+
+  // TODO: val id and pubDigest
+
+  if (pubKey) {
+    return new PeerIdWithIs(pubDigest, null, pubKey)
+  }
+
+  if (id) {
+    return new PeerIdWithIs(id)
+  }
+
+  throw new Error('Protobuf did not contain any usable key material')
+}
+
+exports.isPeerId = (peerId) => {
   return Boolean(typeof peerId === 'object' &&
     peerId._id &&
     peerId._idB58String)

src/proto.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const protons = require('protons')
+module.exports = protons(`
+
+message PeerIdProto {
+  required bytes id = 1;
+  bytes pubKey = 2;
+  bytes privKey = 3;
+}
+
+`)

test/fixtures/sample-id.js

@@ -3,5 +3,6 @@
 module.exports = {
   id: '122019318b6e5e0cf93a2314bf01269a2cc23cd3dcd452d742cdb9379d8646f6e4a9',
   privKey: 'CAASpgkwggSiAgEAAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAECggEAZtju/bcKvKFPz0mkHiaJcpycy9STKphorpCT83srBVQi59CdFU6Mj+aL/xt0kCPMVigJw8P3/YCEJ9J+rS8BsoWE+xWUEsJvtXoT7vzPHaAtM3ci1HZd302Mz1+GgS8Epdx+7F5p80XAFLDUnELzOzKftvWGZmWfSeDnslwVONkL/1VAzwKy7Ce6hk4SxRE7l2NE2OklSHOzCGU1f78ZzVYKSnS5Ag9YrGjOAmTOXDbKNKN/qIorAQ1bovzGoCwx3iGIatQKFOxyVCyO1PsJYT7JO+kZbhBWRRE+L7l+ppPER9bdLFxs1t5CrKc078h+wuUr05S1P1JjXk68pk3+kQKBgQDeK8AR11373Mzib6uzpjGzgNRMzdYNuExWjxyxAzz53NAR7zrPHvXvfIqjDScLJ4NcRO2TddhXAfZoOPVH5k4PJHKLBPKuXZpWlookCAyENY7+Pd55S8r+a+MusrMagYNljb5WbVTgN8cgdpim9lbbIFlpN6SZaVjLQL3J8TWH6wKBgQDSChzItkqWX11CNstJ9zJyUE20I7LrpyBJNgG1gtvz3ZMUQCn3PxxHtQzN9n1P0mSSYs+jBKPuoSyYLt1wwe10/lpgL4rkKWU3/m1Myt0tveJ9WcqHh6tzcAbb/fXpUFT/o4SWDimWkPkuCb+8j//2yiXk0a/T2f36zKMuZvujqQKBgC6B7BAQDG2H2B/ijofp12ejJU36nL98gAZyqOfpLJ+FeMz4TlBDQ+phIMhnHXA5UkdDapQ+zA3SrFk+6yGk9Vw4Hf46B+82SvOrSbmnMa+PYqKYIvUzR4gg34rL/7AhwnbEyD5hXq4dHwMNsIDq+l2elPjwm/U9V0gdAl2+r50HAoGALtsKqMvhv8HucAMBPrLikhXP/8um8mMKFMrzfqZ+otxfHzlhI0L08Bo3jQrb0Z7ByNY6M8epOmbCKADsbWcVre/AAY0ZkuSZK/CaOXNX/AhMKmKJh8qAOPRY02LIJRBCpfS4czEdnfUhYV/TYiFNnKRj57PPYZdTzUsxa/yVTmECgYBr7slQEjb5Onn5mZnGDh+72BxLNdgwBkhO0OCdpdISqk0F0Pxby22DFOKXZEpiyI9XYP1C8wPiJsShGm2yEwBPWXnrrZNWczaVuCbXHrZkWQogBDG3HGXNdU4MAWCyiYlyinIBpPpoAJZSzpGLmWbMWh28+RJS6AQX6KHrK1o2uw==',
-  pubKey: 'CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAE='
+  pubKey: 'CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAE=',
+  marshaled: '0a22122019318b6e5e0cf93a2314bf01269a2cc23cd3dcd452d742cdb9379d8646f6e4a912ab02080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b2302030100011aab09080012a609308204a20201000282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b2302030100010282010066d8eefdb70abca14fcf49a41e2689729c9ccbd4932a9868ae9093f37b2b055422e7d09d154e8c8fe68bff1b749023cc562809c3c3f7fd808427d27ead2f01b28584fb159412c26fb57a13eefccf1da02d337722d4765ddf4d8ccf5f86812f04a5dc7eec5e69f345c014b0d49c42f33b329fb6f58666659f49e0e7b25c1538d90bff5540cf02b2ec27ba864e12c5113b976344d8e9254873b30865357fbf19cd560a4a74b9020f58ac68ce0264ce5c36ca34a37fa88a2b010d5ba2fcc6a02c31de21886ad40a14ec72542c8ed4fb09613ec93be9196e105645113e2fb97ea693c447d6dd2c5c6cd6de42aca734efc87ec2e52bd394b53f52635e4ebca64dfe9102818100de2bc011d75dfbdccce26fabb3a631b380d44ccdd60db84c568f1cb1033cf9dcd011ef3acf1ef5ef7c8aa30d270b27835c44ed9375d85701f66838f547e64e0f24728b04f2ae5d9a56968a24080c84358efe3dde794bcafe6be32eb2b31a8183658dbe566d54e037c7207698a6f656db20596937a4996958cb40bdc9f13587eb02818100d20a1cc8b64a965f5d4236cb49f73272504db423b2eba720493601b582dbf3dd93144029f73f1c47b50ccdf67d4fd2649262cfa304a3eea12c982edd70c1ed74fe5a602f8ae4296537fe6d4ccadd2dbde27d59ca8787ab737006dbfdf5e95054ffa384960e299690f92e09bfbc8ffff6ca25e4d1afd3d9fdfacca32e66fba3a90281802e81ec10100c6d87d81fe28e87e9d767a3254dfa9cbf7c800672a8e7e92c9f8578ccf84e504343ea6120c8671d70395247436a943ecc0dd2ac593eeb21a4f55c381dfe3a07ef364af3ab49b9a731af8f62a29822f533478820df8acbffb021c276c4c83e615eae1d1f030db080eafa5d9e94f8f09bf53d57481d025dbeaf9d070281802edb0aa8cbe1bfc1ee7003013eb2e29215cfffcba6f2630a14caf37ea67ea2dc5f1f39612342f4f01a378d0adbd19ec1c8d63a33c7a93a66c22800ec6d6715adefc0018d1992e4992bf09a397357fc084c2a628987ca8038f458d362c8251042a5f4b873311d9df521615fd362214d9ca463e7b3cf619753cd4b316bfc954e610281806beec9501236f93a79f99999c60e1fbbd81c4b35d83006484ed0e09da5d212aa4d05d0fc5bcb6d8314e297644a62c88f5760fd42f303e226c4a11a6db213004f5979ebad9356733695b826d71eb664590a200431b71c65cd754e0c0160b28989728a7201a4fa68009652ce918b9966cc5a1dbcf91252e80417e8a1eb2b5a36bb'
 }

test/peer-id.spec.js

@@ -8,121 +8,210 @@ chai.use(dirtyChai)
 const expect = chai.expect
 const crypto = require('libp2p-crypto')
 const mh = require('multihashes')
-const parallel = require('async/parallel')
+const CID = require('cids')
-const Buffer = require('safe-buffer').Buffer
 
 const PeerId = require('../src')
 
+const util = require('util')
+
 const testId = require('./fixtures/sample-id')
 const testIdHex = testId.id
 const testIdBytes = mh.fromHexString(testId.id)
 const testIdB58String = mh.toB58String(testIdBytes)
+const testIdCID = new CID(1, 'libp2p-key', testIdBytes)
+const testIdCIDString = testIdCID.toBaseEncodedString('base32')
 
 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)
-      expect(id.toB58String().length).to.equal(46)
-      done()
-    })
   })
 
-  it('isPeerId', (done) => {
+  it('can be created for a Secp256k1 key', async () => {
-    PeerId.create((err, id) => {
+    const id = await PeerId.create({ keyType: 'secp256k1', bits: 256 })
-      expect(err).to.not.exist()
+    const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
-      expect(PeerId.isPeerId(id)).to.equal(true)
+    expect(id.toB58String()).to.equal(expB58)
-      expect(PeerId.isPeerId('aaa')).to.equal(false)
-      expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
-      done()
-    })
   })
 
-  it('throws on changing the id', (done) => {
+  it('can get the public key from a Secp256k1 key', async () => {
-    PeerId.create((err, id) => {
+    const original = await PeerId.create({ keyType: 'secp256k1', bits: 256 })
-      expect(err).to.not.exist()
+    const newId = PeerId.createFromB58String(original.toB58String())
-      expect(id.toB58String().length).to.equal(46)
+    expect(original.pubKey.bytes).to.eql(newId.pubKey.bytes)
-      expect(() => {
-        id.id = Buffer.from('hello')
-      }).to.throw(/immutable/)
-      done()
-    })
   })
 
-  it('recreate an Id from Hex string', () => {
+  it('isPeerId', async () => {
+    const id = await PeerId.create(testOpts)
+    expect(PeerId.isPeerId(id)).to.equal(true)
+    expect(PeerId.isPeerId('aaa')).to.equal(false)
+    expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
+  })
+
+  it('throws on changing the id', async () => {
+    const id = await PeerId.create(testOpts)
+    expect(id.toB58String().length).to.equal(46)
+    expect(() => {
+      id.id = Buffer.from('hello')
+    }).to.throw(/immutable/)
+  })
+
+  it('recreate from Hex string', () => {
     const id = PeerId.createFromHexString(testIdHex)
-    expect(testIdBytes).to.deep.equal(id.id)
+    expect(testIdBytes).to.deep.equal(id.toBytes())
   })
 
-  it('Recreate an Id from a Buffer', () => {
+  it('recreate from a Buffer', () => {
     const id = PeerId.createFromBytes(testIdBytes)
     expect(testId.id).to.equal(id.toHexString())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
   })
 
-  it('Recreate a B58 String', () => {
+  it('recreate from a B58 String', () => {
     const id = PeerId.createFromB58String(testIdB58String)
     expect(testIdB58String).to.equal(id.toB58String())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
   })
 
-  it('Recreate from a Public Key', (done) => {
+  it('recreate from CID object', () => {
-    PeerId.createFromPubKey(testId.pubKey, (err, id) => {
+    const id = PeerId.createFromCID(testIdCID)
-      expect(err).to.not.exist()
+    expect(testIdCIDString).to.equal(id.toString())
-      expect(testIdB58String).to.equal(id.toB58String())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
-      done()
-    })
   })
 
-  it('Recreate from a Private Key', (done) => {
+  it('recreate from Base58 String (CIDv0))', () => {
-    PeerId.createFromPrivKey(testId.privKey, (err, id) => {
+    const id = PeerId.createFromCID(testIdB58String)
-      expect(err).to.not.exist()
+    expect(testIdCIDString).to.equal(id.toString())
-      expect(testIdB58String).to.equal(id.toB58String())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
-
-      const encoded = Buffer.from(testId.privKey, 'base64')
-      PeerId.createFromPrivKey(encoded, (err, id2) => {
-        expect(err).to.not.exist()
-        expect(testIdB58String).to.equal(id2.toB58String())
-        done()
-      })
-    })
   })
 
-  it('Compare generated ID with one created from PubKey', (done) => {
+  it('recreate from CIDv1 Base32 (libp2p-key multicodec)', () => {
-    PeerId.create((err, id1) => {
+    const cid = new CID(1, 'libp2p-key', testIdBytes)
-      expect(err).to.not.exist()
+    const cidString = cid.toBaseEncodedString('base32')
-
+    const id = PeerId.createFromCID(cidString)
-      PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
+    expect(cidString).to.equal(id.toString())
-        expect(err).to.not.exist()
+    expect(testIdBytes).to.deep.equal(id.toBytes())
-        expect(id1.id).to.be.eql(id2.id)
-        done()
-      })
-    })
   })
 
-  it('Non-default # of bits', (done) => {
+  it('recreate from CIDv1 Base32 (dag-pb multicodec)', () => {
-    PeerId.create({ bits: 1024 }, (err, shortId) => {
+    const cid = new CID(1, 'dag-pb', testIdBytes)
-      expect(err).to.not.exist()
+    const cidString = cid.toBaseEncodedString('base32')
-      PeerId.create({ bits: 4096 }, (err, longId) => {
+    const id = PeerId.createFromCID(cidString)
-        expect(err).to.not.exist()
+    // toString should return CID with multicodec set to libp2p-key
-        expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
+    expect(new CID(id.toString()).codec).to.equal('libp2p-key')
-        done()
+    expect(testIdBytes).to.deep.equal(id.toBytes())
-      })
-    })
   })
 
-  it('Pretty printing', (done) => {
+  it('recreate from CID Buffer', () => {
-    PeerId.create((err, id1) => {
+    const id = PeerId.createFromCID(testIdCID.buffer)
-      expect(err).to.not.exist()
+    expect(testIdCIDString).to.equal(id.toString())
-      PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
+    expect(testIdBytes).to.deep.equal(id.toBytes())
-        expect(err).to.not.exist()
+  })
-        expect(id1.toPrint()).to.be.eql(id2.toPrint())
+
-        done()
+  it('throws on invalid CID multicodec', () => {
-      })
+    // only libp2p and dag-pb are supported
-    })
+    const invalidCID = new CID(1, 'raw', testIdBytes).toBaseEncodedString('base32')
+    expect(() => {
+      PeerId.createFromCID(invalidCID)
+    }).to.throw(/Supplied PeerID CID has invalid multicodec: raw/)
+  })
+
+  it('throws on invalid CID value', () => {
+    // using function code that does not represent valid hash function
+    // https://github.com/multiformats/js-multihash/blob/b85999d5768bf06f1b0f16b926ef2cb6d9c14265/src/constants.js#L345
+    const invalidCID = 'QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L'
+    expect(() => {
+      PeerId.createFromCID(invalidCID)
+    }).to.throw(/multihash unknown function code: 0x50/)
+  })
+
+  it('throws on invalid CID object', () => {
+    const invalidCID = {}
+    expect(() => {
+      PeerId.createFromCID(invalidCID)
+    }).to.throw(/Invalid version, must be a number equal to 1 or 0/)
+  })
+
+  it('throws on invalid CID object', () => {
+    const invalidCID = {}
+    expect(() => {
+      PeerId.createFromCID(invalidCID)
+    }).to.throw(/Invalid version, must be a number equal to 1 or 0/)
+  })
+
+  it('recreate from a Public Key', async () => {
+    const id = await PeerId.createFromPubKey(testId.pubKey)
+    expect(testIdB58String).to.equal(id.toB58String())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
+  })
+
+  it('recreate from a Private Key', async () => {
+    const id = await PeerId.createFromPrivKey(testId.privKey)
+    expect(testIdB58String).to.equal(id.toB58String())
+    const encoded = Buffer.from(testId.privKey, 'base64')
+    const id2 = await PeerId.createFromPrivKey(encoded)
+    expect(testIdB58String).to.equal(id2.toB58String())
+    expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
+  })
+
+  it('recreate from Protobuf', async () => {
+    const id = await PeerId.createFromProtobuf(testId.marshaled)
+    expect(testIdB58String).to.equal(id.toB58String())
+    const encoded = Buffer.from(testId.privKey, 'base64')
+    const id2 = await PeerId.createFromPrivKey(encoded)
+    expect(testIdB58String).to.equal(id2.toB58String())
+    expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
+    expect(id.marshal().toString('hex')).to.deep.equal(testId.marshaled)
+  })
+
+  it('can be created from a Secp256k1 public key', async () => {
+    const privKey = await crypto.keys.generateKeyPair('secp256k1', 256)
+    const id = await PeerId.createFromPubKey(privKey.public.bytes)
+    const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
+    expect(id.toB58String()).to.equal(expB58)
+  })
+
+  it('can be created from a Secp256k1 private key', async () => {
+    const privKey = await crypto.keys.generateKeyPair('secp256k1', 256)
+    const id = await PeerId.createFromPrivKey(privKey.bytes)
+    const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
+    expect(id.toB58String()).to.equal(expB58)
+  })
+
+  it('Compare generated ID with one created from PubKey', async () => {
+    const id1 = await PeerId.create(testOpts)
+    const id2 = await PeerId.createFromPubKey(id1.marshalPubKey())
+    expect(id1.id).to.be.eql(id2.id)
+  })
+
+  it('Works with default options', async function () {
+    this.timeout(10000)
+    const id = await PeerId.create()
+    expect(id.toB58String().length).to.equal(46)
+  })
+
+  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)
+  })
+
+  it('Pretty printing', async () => {
+    const id1 = await PeerId.create(testOpts)
+    const id2 = await PeerId.createFromPrivKey((id1.toJSON()).privKey)
+    expect(id1.toPrint()).to.be.eql(id2.toPrint())
+    expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>')
   })
 
   it('toBytes', () => {
@@ -130,102 +219,104 @@ 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[0])).to.equal(true)
-      expect(ids[0].isEqual(ids[1])).to.equal(false)
+    expect(ids[0].isEqual(ids[1])).to.equal(false)
-      expect(ids[0].isEqual(ids[0].id)).to.equal(true)
+    expect(ids[0].isEqual(ids[0].id)).to.equal(true)
-      expect(ids[0].isEqual(ids[1].id)).to.equal(false)
+    expect(ids[0].isEqual(ids[1].id)).to.equal(false)
-      done()
+  })
-    })
+
+  it('equals', async () => {
+    const ids = await Promise.all([
+      PeerId.create(testOpts),
+      PeerId.create(testOpts)
+    ])
+
+    expect(ids[0].equals(ids[0])).to.equal(true)
+    expect(ids[0].equals(ids[1])).to.equal(false)
+    expect(ids[0].equals(ids[0].id)).to.equal(true)
+    expect(ids[0].equals(ids[1].id)).to.equal(false)
   })
 
   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())
+      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)
+    })
 
-        PeerId.createFromJSON(id.toJSON(), (err, other) => {
+    it('only id', async () => {
-          expect(err).to.not.exist()
+      const key = await crypto.keys.generateKeyPair('RSA', 1024)
-          expect(id.toB58String()).to.equal(other.toB58String())
+      const digest = await key.public.hash()
-          expect(id.privKey.bytes).to.eql(other.privKey.bytes)
+      const id = PeerId.createFromBytes(digest)
-          expect(id.pubKey.bytes).to.eql(other.pubKey.bytes)
+      expect(id.privKey).to.not.exist()
-          done()
+      expect(id.pubKey).to.not.exist()
+      const other = await PeerId.createFromJSON(id.toJSON())
+      expect(id.toB58String()).to.equal(other.toB58String())
+    })
+
+    it('go interop', async () => {
+      const id = await PeerId.createFromJSON(goId)
+      const digest = await id.privKey.public.hash()
+      expect(mh.toB58String(digest)).to.eql(goId.id)
+    })
+  })
+
+  it('set privKey (valid)', async () => {
+    const peerId = await PeerId.create(testOpts)
+    // @ts-ignore
+    peerId.privKey = peerId._privKey
+    expect(peerId.isValid()).to.equal(true)
+  })
+
+  it('set pubKey (valid)', async () => {
+    const peerId = await PeerId.create(testOpts)
+    // @ts-ignore
+    peerId.pubKey = peerId._pubKey
+    expect(peerId.isValid()).to.equal(true)
+  })
+
+  it('set privKey (invalid)', async () => {
+    const peerId = await PeerId.create(testOpts)
+    // @ts-ignore
+    peerId.privKey = Buffer.from('bufff')
+    expect(peerId.isValid()).to.equal(false)
+  })
+
+  it('set pubKey (invalid)', async () => {
+    const peerId = await PeerId.create(testOpts)
+    // @ts-ignore
+    peerId.pubKey = Buffer.from('bufff')
+    expect(peerId.isValid()).to.equal(false)
+  })
+
+  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', 'createFromProtobuf']
+
+    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()
+          }
         })
-      })
+      }
-    })
+    }
-
-    it('only id', (done) => {
-      crypto.keys.generateKeyPair('RSA', 1024, (err, key) => {
-        expect(err).to.not.exist()
-        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()
-
-          PeerId.createFromJSON(id.toJSON(), (err, other) => {
-            expect(err).to.not.exist()
-            expect(id.toB58String()).to.equal(other.toB58String())
-            done()
-          })
-        })
-      })
-    })
-
-    it('go interop', (done) => {
-      PeerId.createFromJSON(goId, (err, id) => {
-        expect(err).to.not.exist()
-        id.privKey.public.hash((err, digest) => {
-          expect(err).to.not.exist()
-          expect(mh.toB58String(digest)).to.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)
-    })
-  })
-
-  it('set pubKey (valid)', (done) => {
-    PeerId.create((err, peerId) => {
-      expect(err).to.not.exist()
-      peerId.pubKey = peerId._pubKey
-      peerId.isValid(done)
-    })
-  })
-
-  it('set privKey (invalid)', (done) => {
-    PeerId.create((err, peerId) => {
-      expect(err).to.not.exist()
-      peerId.privKey = Buffer.from('bufff')
-      peerId.isValid((err) => {
-        expect(err).to.exist()
-        done()
-      })
-    })
-  })
-
-  it('set pubKey (invalid)', (done) => {
-    PeerId.create((err, peerId) => {
-      expect(err).to.not.exist()
-      peerId.pubKey = Buffer.from('buffff')
-      peerId.isValid((err) => {
-        expect(err).to.exist()
-        done()
-      })
-    })
   })
 
   describe('throws on inconsistent data', () => {
@@ -233,37 +324,30 @@ describe('PeerId', () => {
     let k2
     let k3
 
-    before((done) => {
+    before(async () => {
-      parallel([
+      const keys = await Promise.all([
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
+        crypto.keys.generateKeyPair('RSA', 512),
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
+        crypto.keys.generateKeyPair('RSA', 512),
-        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb)
+        crypto.keys.generateKeyPair('RSA', 512)
-      ], (err, keys) => {
+      ])
-        expect(err).to.not.exist()
 
-        k1 = keys[0]
+      k1 = keys[0]
-        k2 = keys[1]
+      k2 = keys[1]
-        k3 = keys[2]
+      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', () => {

tsconfig.json

@@ -0,0 +1,37 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "target": "ES5",
+        "noImplicitAny": false,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "esModuleInterop": true,
+        "resolveJsonModule": true,
+        "allowJs": true,
+        "checkJs": true,
+        "baseUrl": ".",
+        "paths": {
+            "peer-id": [
+                "./src",
+                "../src",
+            ]
+        },
+        "types": [
+            "node",
+            "mocha",
+            "chai"
+        ],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "./src/index.d.ts",
+    ],
+    "include": [
+        "./test/**/*.spec.js"
+    ]
+}