chore: release version v0.13.7

chore: update contributors
feat: adds typescript types + type tests (#110 )
2025-07-04 18:11:36 +00:00 · 2020-01-27 12:10:00 +01:00 · 2020-01-27 12:09:59 +01:00 · 2020-01-27 12:07:52 +01:00 · 2019-12-18 10:43:10 +00:00 · 2019-12-18 10:43:10 +00:00
14 changed files with 1287 additions and 444 deletions
--- a/.gitignore
+++ b/.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
--- a/.npmignore
+++ b/.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
--- a/.travis.yml
+++ b/.travis.yml
@ -1,37 +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: 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 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
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -0,0 +1,371 @@
+<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)
+
+
+
--- a/README.md
+++ b/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/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
+
+[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) => {
-  if (err) { throw err }
-  console.log(JSON.stringify(id.toJSON(), null, 2))
-})
+const id = await PeerId.create({ bits: 1024, keyType: 'rsa' })
+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}`
- `callback: Function`
+- `opts: Object`: Default: `{bits: 2048, keyType: 'rsa'}`

-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.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`
+
+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

--- a/circle.yml
+++ b/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
--- a/package.json
+++ b/package.json
@ -1,63 +1,86 @@
 {
  "name": "peer-id",
-  "version": "0.8.8",
+  "version": "0.13.7",
  "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",
-    "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",
+    "test:types": "npx tsc",
+    "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"
+    "@types/chai": "^4.2.7",
+    "@types/dirty-chai": "^2.0.2",
+    "@types/mocha": "^5.2.7",
+    "aegir": "^20.0.0",
+    "bundlesize": "~0.18.0",
+    "chai": "^4.2.0",
+    "dirty-chai": "^2.0.1"
  },
  "dependencies": {
-    "async": "^2.5.0",
-    "libp2p-crypto": "~0.8.8",
-    "lodash": "^4.17.4",
-    "multihashes": "~0.4.5"
+    "cids": "^0.7.3",
+    "class-is": "^1.1.0",
+    "libp2p-crypto": "~0.17.2",
+    "multihashes": "~0.4.15",
+    "protons": "^1.0.1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/libp2p/js-peer-id.git"
  },
  "contributors": [
+    "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>",
    "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>"
  ]
-}
+}
--- a/src/bin.js
+++ b/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) => {
-  if (err) {
-    throw err
-  }
+async function main () {
+  const id = await PeerId.create()
+  console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console
+}

-  console.log(JSON.stringify(id.toJSON(), null, 2))
-})
+main()
--- a/src/index.d.ts
+++ b/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): boolean
+
+  /**
+   * 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.
+   */
+  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;
--- a/src/index.js
+++ b/src/index.js
@ -5,9 +5,11 @@
 'use strict'

 const mh = require('multihashes')
-const crypto = require('libp2p-crypto')
+const CID = require('cids')
+const cryptoKeys = require('libp2p-crypto/src/keys')
 const assert = require('assert')
-const waterfall = require('async/waterfall')
+const withIs = require('class-is')
+const { PeerIdProto } = require('./proto')

 class PeerId {
  constructor (id, privKey, pubKey) {
@ -47,6 +49,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) {
@ -56,20 +70,39 @@ class PeerId {
  // Return the protobuf version of the public key, matching go ipfs formatting
  marshalPubKey () {
    if (this.pubKey) {
-      return crypto.marshalPublicKey(this.pubKey)
+      return cryptoKeys.marshalPublicKey(this.pubKey)
    }
  }

  // Return the protobuf version of the private key, matching go ipfs formatting
  marshalPrivKey () {
    if (this.privKey) {
-      return crypto.marshalPrivateKey(this.privKey)
+      return cryptoKeys.marshalPrivateKey(this.privKey)
    }
  }

-  // pretty print
+  // 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
@ -95,7 +128,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) {
@ -105,153 +153,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) {
-    // TODO Needs better checking
-    if (this.privKey &&
+  isValid () {
+    // TODO: needs better checking
+    return Boolean(this.privKey &&
      this.privKey.public &&
      this.privKey.public.bytes &&
      Buffer.isBuffer(this.pubKey.bytes) &&
-      this.privKey.public.bytes.equals(this.pubKey.bytes)) {
-      callback()
-    } else {
-      callback(new Error('Keys not match'))
-    }
+      this.privKey.public.bytes.equals(this.pubKey.bytes))
  }
 }

-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) {
-  if (typeof opts === 'function') {
-    callback = opts
-    opts = {}
-  }
+exports.create = async (opts) => {
  opts = opts || {}
  opts.bits = opts.bits || 2048
+  opts.keyType = opts.keyType || 'RSA'

-  waterfall([
-    (cb) => crypto.generateKeyPair('RSA', opts.bits, cb),
-    (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))
-  })
+  const key = await cryptoKeys.generateKeyPair(opts.keyType, opts.bits)
+  return computePeerId(key, key.public)
 }

-exports.createFromHexString = function (str) {
-  return new PeerId(mh.fromHexString(str))
+exports.createFromHexString = (str) => {
+  return new PeerIdWithIs(mh.fromHexString(str))
 }

-exports.createFromBytes = function (buf) {
-  return new PeerId(buf)
+exports.createFromBytes = (buf) => {
+  return new PeerIdWithIs(buf)
 }

-exports.createFromB58String = function (str) {
-  return new PeerId(mh.fromB58String(str))
+exports.createFromB58String = (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) {
-  if (typeof callback !== 'function') {
-    throw new Error('callback is required')
-  }
-
+exports.createFromPubKey = async (key) => {
  let buf = key
+
  if (typeof buf === 'string') {
-    buf = new Buffer(key, 'base64')
+    buf = Buffer.from(key, 'base64')
  }

-  const pubKey = crypto.unmarshalPublicKey(buf)
+  if (!Buffer.isBuffer(buf)) {
+    throw new Error('Supplied key is neither a base64 string nor a buffer')
+  }

-  pubKey.hash((err, digest) => {
-    if (err) {
-      return callback(err)
-    }
-
-    callback(null, new PeerId(digest, null, pubKey))
-  })
+  const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
+  return computePeerId(null, pubKey)
 }

 // Private key input will be a string
-exports.createFromPrivKey = function (key, callback) {
+exports.createFromPrivKey = async (key) => {
  let buf = key
+
  if (typeof buf === 'string') {
-    buf = new Buffer(key, 'base64')
+    buf = Buffer.from(key, 'base64')
  }

-  if (typeof callback !== 'function') {
-    throw new Error('callback is required')
+  if (!Buffer.isBuffer(buf)) {
+    throw new Error('Supplied key is neither a base64 string nor a buffer')
  }

-  waterfall([
-    (cb) => crypto.unmarshalPrivateKey(buf, cb),
-    (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))
-  })
+  const privKey = await cryptoKeys.unmarshalPrivateKey(buf)
+  return computePeerId(privKey, privKey.public)
 }

-exports.createFromJSON = function (obj, callback) {
-  if (typeof callback !== 'function') {
-    throw new Error('callback is required')
-  }
-
+exports.createFromJSON = async (obj) => {
  const id = mh.fromB58String(obj.id)
-  const rawPrivKey = obj.privKey && new Buffer(obj.privKey, 'base64')
-  const rawPubKey = obj.pubKey && new Buffer(obj.pubKey, 'base64')
-  const pub = rawPubKey && crypto.unmarshalPublicKey(rawPubKey)
+  const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
+  const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
+  const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)

-  if (rawPrivKey) {
-    waterfall([
-      (cb) => crypto.unmarshalPrivateKey(rawPrivKey, cb),
-      (priv, cb) => priv.public.hash((err, digest) => {
-        cb(err, digest, priv)
-      }),
-      (privDigest, priv, cb) => {
-        if (pub) {
-          pub.hash((err, pubDigest) => {
-            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))
+  if (!rawPrivKey) {
+    return new PeerIdWithIs(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)
--- a/src/proto.js
+++ b/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;
+}
+
+`)
--- a/test/fixtures/sample-id.js
+++ b/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'
 }
--- a/test/peer-id.spec.js
+++ b/test/peer-id.spec.js
@ -8,120 +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 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) => {
-    PeerId.create((err, id) => {
-      expect(err).to.not.exist()
-      expect(id.toB58String().length).to.equal(46)
-      done()
-    })
+  it('create a new id', async () => {
+    const id = await PeerId.create(testOpts)
+    expect(id.toB58String().length).to.equal(46)
  })

-  it('isPeerId', (done) => {
-    PeerId.create((err, id) => {
-      expect(err).to.not.exist()
-      expect(PeerId.isPeerId(id)).to.equal(true)
-      expect(PeerId.isPeerId('aaa')).to.equal(false)
-      expect(PeerId.isPeerId(new Buffer('batatas'))).to.equal(false)
-      done()
-    })
+  it('can be created for a Secp256k1 key', async () => {
+    const id = await PeerId.create({ keyType: 'secp256k1', bits: 256 })
+    const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
+    expect(id.toB58String()).to.equal(expB58)
  })

-  it('throws on changing the id', (done) => {
-    PeerId.create((err, id) => {
-      expect(err).to.not.exist()
-      expect(id.toB58String().length).to.equal(46)
-      expect(() => {
-        id.id = new Buffer('hello')
-      }).to.throw(/immutable/)
-      done()
-    })
+  it('can get the public key from a Secp256k1 key', async () => {
+    const original = await PeerId.create({ keyType: 'secp256k1', bits: 256 })
+    const newId = PeerId.createFromB58String(original.toB58String())
+    expect(original.pubKey.bytes).to.eql(newId.pubKey.bytes)
  })

-  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) => {
-    PeerId.createFromPubKey(testId.pubKey, (err, id) => {
-      expect(err).to.not.exist()
-      expect(testIdB58String).to.equal(id.toB58String())
-      done()
-    })
+  it('recreate from CID object', () => {
+    const id = PeerId.createFromCID(testIdCID)
+    expect(testIdCIDString).to.equal(id.toString())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
  })

-  it('Recreate from a Private Key', (done) => {
-    PeerId.createFromPrivKey(testId.privKey, (err, id) => {
-      expect(err).to.not.exist()
-      expect(testIdB58String).to.equal(id.toB58String())
-
-      const encoded = new Buffer(testId.privKey, 'base64')
-      PeerId.createFromPrivKey(encoded, (err, id2) => {
-        expect(err).to.not.exist()
-        expect(testIdB58String).to.equal(id2.toB58String())
-        done()
-      })
-    })
+  it('recreate from Base58 String (CIDv0))', () => {
+    const id = PeerId.createFromCID(testIdB58String)
+    expect(testIdCIDString).to.equal(id.toString())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
  })

-  it('Compare generated ID with one created from PubKey', (done) => {
-    PeerId.create((err, id1) => {
-      expect(err).to.not.exist()
-
-      PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
-        expect(err).to.not.exist()
-        expect(id1.id).to.be.eql(id2.id)
-        done()
-      })
-    })
+  it('recreate from CIDv1 Base32 (libp2p-key multicodec)', () => {
+    const cid = new CID(1, 'libp2p-key', testIdBytes)
+    const cidString = cid.toBaseEncodedString('base32')
+    const id = PeerId.createFromCID(cidString)
+    expect(cidString).to.equal(id.toString())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
  })

-  it('Non-default # of bits', (done) => {
-    PeerId.create({ bits: 1024 }, (err, shortId) => {
-      expect(err).to.not.exist()
-      PeerId.create({ bits: 4096 }, (err, longId) => {
-        expect(err).to.not.exist()
-        expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
-        done()
-      })
-    })
+  it('recreate from CIDv1 Base32 (dag-pb multicodec)', () => {
+    const cid = new CID(1, 'dag-pb', testIdBytes)
+    const cidString = cid.toBaseEncodedString('base32')
+    const id = PeerId.createFromCID(cidString)
+    // toString should return CID with multicodec set to libp2p-key
+    expect(new CID(id.toString()).codec).to.equal('libp2p-key')
+    expect(testIdBytes).to.deep.equal(id.toBytes())
  })

-  it('Pretty printing', (done) => {
-    PeerId.create((err, id1) => {
-      expect(err).to.not.exist()
-      PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
-        expect(err).to.not.exist()
-        expect(id1.toPrint()).to.be.eql(id2.toPrint())
-        done()
-      })
-    })
+  it('recreate from CID Buffer', () => {
+    const id = PeerId.createFromCID(testIdCID.buffer)
+    expect(testIdCIDString).to.equal(id.toString())
+    expect(testIdBytes).to.deep.equal(id.toBytes())
+  })
+
+  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', () => {
@ -129,110 +219,104 @@ describe('PeerId', () => {
    expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
  })

-  it('isEqual', (done) => {
-    parallel([
-      (cb) => PeerId.create(cb),
-      (cb) => PeerId.create(cb)
-    ], (err, ids) => {
-      expect(err).to.not.exist()
-      expect(ids[0].isEqual(ids[0])).to.equal(true)
-      expect(ids[0].isEqual(ids[1])).to.equal(false)
-      expect(ids[0].isEqual(ids[0].id)).to.equal(true)
-      expect(ids[0].isEqual(ids[1].id)).to.equal(false)
-      done()
-    })
+  it('isEqual', async () => {
+    const ids = await Promise.all([
+      PeerId.create(testOpts),
+      PeerId.create(testOpts)
+    ])
+
+    expect(ids[0].isEqual(ids[0])).to.equal(true)
+    expect(ids[0].isEqual(ids[1])).to.equal(false)
+    expect(ids[0].isEqual(ids[0].id)).to.equal(true)
+    expect(ids[0].isEqual(ids[1].id)).to.equal(false)
+  })
+
+  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) => {
-      PeerId.create({ bits: 1024 }, (err, id) => {
-        expect(err).to.not.exist()
+    it('full node', async () => {
+      const id = await PeerId.create(testOpts)
+      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) => {
-          expect(err).to.not.exist()
-          expect(id.toB58String()).to.equal(other.toB58String())
-          expect(id.privKey.bytes).to.eql(other.privKey.bytes)
-          expect(id.pubKey.bytes).to.eql(other.pubKey.bytes)
-          done()
+    it('only id', async () => {
+      const key = await crypto.keys.generateKeyPair('RSA', 1024)
+      const digest = await key.public.hash()
+      const id = PeerId.createFromBytes(digest)
+      expect(id.privKey).to.not.exist()
+      expect(id.pubKey).to.not.exist()
+      const other = await PeerId.createFromJSON(id.toJSON())
+      expect(id.toB58String()).to.equal(other.toB58String())
+    })
+
+    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.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.be.eql(
-            goId.id
-          )
-          done()
-        })
-      })
-    })
-  })
-
-  it('set privKey (valid)', (done) => {
-    PeerId.create((err, peerId) => {
-      expect(err).to.not.exist()
-      peerId.privKey = peerId._privKey
-      peerId.isValid(done)
-    })
-  })
-
-  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 = new Buffer('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 = new Buffer('buffff')
-      peerId.isValid((err) => {
-        expect(err).to.exist()
-        done()
-      })
-    })
+      }
+    }
  })

  describe('throws on inconsistent data', () => {
@ -240,45 +324,34 @@ describe('PeerId', () => {
    let k2
    let k3

-    before((done) => {
-      parallel([
-        (cb) => crypto.generateKeyPair('RSA', 1024, cb),
-        (cb) => crypto.generateKeyPair('RSA', 1024, cb),
-        (cb) => crypto.generateKeyPair('RSA', 1024, cb)
-      ], (err, keys) => {
-        expect(err).to.not.exist()
+    before(async () => {
+      const keys = await Promise.all([
+        crypto.keys.generateKeyPair('RSA', 512),
+        crypto.keys.generateKeyPair('RSA', 512),
+        crypto.keys.generateKeyPair('RSA', 512)
+      ])

-        k1 = keys[0]
-        k2 = keys[1]
-        k3 = keys[2]
-        done()
-      })
+      k1 = keys[0]
+      k2 = keys[1]
+      k3 = keys[2]
    })

-    it('missmatch private - public key', (done) => {
-      k1.public.hash((err, digest) => {
-        expect(err).to.not.exist()
-        expect(() => new PeerId(digest, k1, k2.public))
-          .to.throw(/inconsistent arguments/)
-        done()
-      })
+    it('missmatch private - public key', async () => {
+      const digest = await k1.public.hash()
+      expect(() => {
+        new PeerId(digest, k1, k2.public) // eslint-disable-line no-new
+      }).to.throw(/inconsistent arguments/)
    })

-    it('missmatch id - private - public key', (done) => {
-      k1.public.hash((err, digest) => {
-        expect(err).to.not.exist()
-        expect(() => new PeerId(digest, k1, k3.public))
-          .to.throw(/inconsistent arguments/)
-        done()
-      })
+    it('missmatch id - private - public key', async () => {
+      const digest = await k1.public.hash()
+      expect(() => {
+        new PeerId(digest, k1, k3.public) // eslint-disable-line no-new
+      }).to.throw(/inconsistent arguments/)
    })

    it('invalid id', () => {
-      expect(
-        () => new PeerId('hello world')
-      ).to.throw(
-        /invalid id/
-      )
+      expect(() => new PeerId('hello world')).to.throw(/invalid id/)
    })
  })
 })
--- a/tsconfig.json
+++ b/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"
+    ]
+}
Author	SHA1	Message	Date
Jacob Heun	a68855a5d2	chore: release version v0.13.7	2020-01-27 12:10:00 +01:00
Jacob Heun	d8c307a44f	chore: update contributors	2020-01-27 12:09:59 +01:00
Carson Farmer	a5070aea6e	feat: adds typescript types + type tests (#110 ) * feat: adds typescript types + type tests Signed-off-by: Carson Farmer <carson.farmer@gmail.com> * feat: updates to latest cids release Signed-off-by: Carson Farmer <carson.farmer@gmail.com>	2020-01-27 12:07:52 +01:00
Vasco Santos	fc9698476f	chore: release version v0.13.6	2019-12-18 10:43:10 +00:00
Vasco Santos	ffe04c12a0	chore: update contributors	2019-12-18 10:43:10 +00:00
Jacob Heun	65e0b746a5	fix: catch errors thrown by multihash decode (#109 )	2019-12-18 10:17:59 +00:00
Christian Paul	74cdb24544	chore: typo publick -> public (#108 )	2019-11-28 11:39:55 +01:00
Vasco Santos	b5335cd4ee	chore: release version v0.13.5	2019-11-12 15:06:13 +01:00
Vasco Santos	519052693d	chore: update contributors	2019-11-12 15:06:13 +01:00
Jacob Heun	bbf0416f08	feat: deprecate isEqual in favor of equals (#107 )	2019-11-12 15:00:11 +01:00
Vasco Santos	4fbf859efc	chore: release version v0.13.4	2019-11-04 19:15:07 +01:00
Vasco Santos	52bd949b43	chore: update contributors	2019-11-04 19:15:07 +01:00
Marcin Rataj	544ca7d74b	feat: support Peer ID represented as CID (#105 ) * feat: support Peer ID represented as CID This change adds two functions: - createFromCID accepts CID as String\|CID\|Buffer and creates PeerId from the multihash value inside of it - toCIDString serializes PeerId multihash into a CIDv1 in Base32, as agreed in https://github.com/libp2p/specs/pull/209 License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org> * refactor: rename toCIDString to toString CIDv1 is self describing, and toString was not defined. Makes sense to use generic toString in this case. This change also: - remembers string with CID, so it is lazily generated only once - switches createFromB58String to createFromCID (b58 is CIDv0), making it easier to migrate existing codebases. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org> * docs: comment tests License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org> * feat: validate CID multicodec - require CID with 'libp2p-key' (CIDv1) or 'dag-pb' (CIDv0 converted to CIDv1) - delegate CID validation to CID constructor License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>	2019-11-04 18:22:29 +01:00
Maciej Krüger	11d4ec10bd	fix: bang in bin.js (#106 )	2019-11-04 12:26:50 +01:00
Nate Foss	4d5bb2cfff	chore: include `marshalPubKey` and example (#104 )	2019-09-29 19:54:45 +02:00
Nate Foss	a2ac32ac0f	chore: fix docs typo (#103 )	2019-09-28 11:33:57 +02:00
Vasco Santos	ed211a943b	chore: release version v0.13.3	2019-09-25 16:30:21 +02:00
Vasco Santos	8ea480a3b0	chore: update contributors	2019-09-25 16:30:21 +02:00
Topper Bowers	f39fb24321	feat: allow nested PeerIds to support pubKey function when using identity encoding (#101 )	2019-09-25 15:39:24 +02:00
Vasco Santos	911aa634d3	chore: lead maintainer update (#98 )	2019-07-30 21:17:24 +02:00
Jacob Heun	94aa3483b3	chore: release version v0.13.2	2019-07-12 18:43:04 +01:00
Jacob Heun	1f1f86f576	chore: update contributors	2019-07-12 18:43:04 +01:00
Maciej Krüger	76864184da	feat: add compact protobuf format (#76 ) * docs: document .createFromProtobuf and .marshal * fix: lint * test: verify .marshal() does it's job	2019-07-12 18:35:46 +01:00
Jacob Heun	f50b2ac016	chore: release version v0.13.1	2019-07-11 20:38:24 +01:00
Jacob Heun	6754752b05	chore: update contributors	2019-07-11 20:38:23 +01:00
Arve Knudsen	17440a3f9a	feat(peerid): support creating from secp256k1; harmonize algo with Go (#95 )	2019-07-11 20:31:39 +01:00
Jacob Heun	989b413a96	chore: release version v0.13.0	2019-07-11 18:26:18 +01:00
Jacob Heun	52ed9c58a5	chore: update contributors	2019-07-11 18:26:18 +01:00
Henrique Dias	c3463c7421	feat: async await (#87 ) BREAKING CHANGE: API refactored to use async/await	2019-07-11 18:09:21 +01:00
Vasco Santos	bbabd7451e	chore: add discourse badge (#93 )	2019-04-18 19:32:14 +02:00
Pedro Teixeira	1624b0f70a	chore: release version v0.12.2	2019-01-09 15:14:15 +00:00
Pedro Teixeira	ce8a6ff77e	chore: update contributors	2019-01-09 15:14:15 +00:00
Hugo Dias	41ce1d4671	chore: fix lint	2019-01-09 15:03:49 +00:00
Hugo Dias	231e553a22	chore: fix lint	2019-01-09 15:03:49 +00:00
Hugo Dias	cd2099305e	fix: clean repo and bundle size reduction	2019-01-09 15:03:49 +00:00
Pedro Teixeira	8e030b24d4	chore: release version v0.12.1	2019-01-03 17:10:26 +00:00
Pedro Teixeira	9f69e1ba74	chore: update contributors	2019-01-03 17:10:26 +00:00
Pedro Teixeira	cbc8c5e2ba	Merge pull request #91 from libp2p/chore/update-deps-20190103 chore: update dependencies	2019-01-03 17:05:15 +00:00
Vasco Santos	77000dbd8b	chore: update dependencies	2019-01-03 16:46:46 +00:00
Pedro Teixeira	eb062759c6	chore: release version v0.12.0	2018-10-18 11:00:01 +01:00
Pedro Teixeira	39e17c0c0b	chore: update contributors	2018-10-18 11:00:01 +01:00
Pedro Teixeira	e03a4098df	chore: update contributors	2018-10-18 10:57:19 +01:00
Pedro Teixeira	d7e633a90b	Merge pull request #84 from libp2p/feat/add-class-is-module feat: add class-is module	2018-10-18 10:50:45 +01:00
Vasco Santos	2e5e666140	fix: add peerIdWithIs to the API functions using the instance	2018-10-17 10:51:42 +01:00
Pedro Teixeira	b388257b69	Merge pull request #86 from libp2p/docs/readme-tweaks docs: various readme tweaks	2018-10-12 19:58:47 +01:00
Maciej Krüger	6ecd9a8cb0	docs: various readme tweaks	2018-10-12 18:01:55 +02:00
Vasco Santos	6513a02e1e	feat: add class-is module	2018-10-04 11:29:31 +01:00
David Dias	bd1dc9bda0	chore: release version v0.11.0	2018-07-02 19:28:04 +02:00
David Dias	31cbb5d94c	chore: update contributors	2018-07-02 19:28:03 +02:00
David Dias	35556c3a37	chore: update deps	2018-07-02 19:26:36 +02:00
Michael Garvin	e8ab1b9281	feat: change toPrint output to match go implementation	2018-07-02 19:26:03 +02:00
David Dias	a786018528	chore: remove pre-commit module	2018-06-04 09:48:30 +01:00
David Dias	417fd330b9	docs: add lead maintainer	2018-06-04 09:48:30 +01:00
David Dias	d74bdebcc8	chore: update deps	2018-06-04 09:48:30 +01:00
David Dias	ffed046595	chore: release version v0.10.7	2018-04-05 16:41:39 +01:00
David Dias	1727a135aa	chore: update contributors	2018-04-05 16:41:39 +01:00
David Dias	466b3a030d	chore: update deps	2018-04-05 16:39:53 +01:00
David Dias	464c92a53b	chore: release version v0.10.6	2018-02-12 09:34:42 +00:00
David Dias	8a608def32	chore: update contributors	2018-02-12 09:34:42 +00:00
David Dias	19deeff432	chore: update deps	2018-02-12 09:33:14 +00:00
David Dias	b18c0082ff	chore: release version v0.10.5	2018-01-27 18:18:00 -08:00
David Dias	2b050bcaa1	chore: update contributors	2018-01-27 18:17:59 -08:00
David Dias	b19edf2ab2	chore: update deps	2018-01-27 18:15:52 -08:00
David Dias	35b384ed15	chore: release version v0.10.4	2017-12-20 12:33:36 +00:00
David Dias	655ceec29b	chore: update contributors	2017-12-20 12:33:36 +00:00
Richard Schneider	8b9a134276	fix: update dependencies (#73 )	2017-12-20 12:32:35 +00:00
David Dias	a637297112	chore: release version v0.10.3	2017-12-01 08:51:43 +00:00
David Dias	e666b7284f	chore: update contributors	2017-12-01 08:51:43 +00:00
Maciej Krüger	156911e162	fix: catch error when unmarshaling instead of crashing (#72 )	2017-12-01 08:49:50 +00:00
ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ	f91f2b6506	chore: Updating CI files (#70 ) * Updating CI files This commit updates all CI scripts to the latest version * Faster tests	2017-11-24 17:46:24 +00:00
David Dias	8f6935499e	chore: release version v0.10.2	2017-10-12 10:21:43 +02:00
David Dias	80da1a54b2	chore: update contributors	2017-10-12 10:21:43 +02:00
David Dias	300266ad51	chore: update deps	2017-10-12 10:20:43 +02:00
Yahya	3abdcdabbb	fix: Always add public key to constructor if possible, Fix for undefined pubKey in remote peers (#68 ) * Always add public key to constructor if possible * extending Non-default # of bits test time, travis took 59521ms License: MIT Signed-off-by: Yahya <ya7yaz@gmail.com>	2017-10-12 10:09:18 +02:00
David Dias	7d3cb8e87c	chore: release version v0.10.1	2017-09-07 14:51:57 +01:00
David Dias	a57c0c6f14	chore: update contributors	2017-09-07 14:51:57 +01:00
Friedel Ziegelmayer	d7088d6650	feat(deps): update aegir and libp2p-crypto (#67 )	2017-09-07 14:50:44 +01:00
David Dias	c945d6ad48	chore: release version v0.10.0	2017-09-03 11:51:33 +01:00
David Dias	0eee1a2a69	chore: update contributors	2017-09-03 11:51:33 +01:00
David Dias	63428faae9	feat: p2p addrs situation (#66 ) * chore: update deps * chore: update gitignore * chore: update CI * chore: update README badge	2017-09-03 11:49:56 +01:00
David Dias	a38e3859d2	chore: release version v0.9.0	2017-07-22 13:38:56 -07:00
David Dias	551fd710be	chore: update contributors	2017-07-22 13:38:55 -07:00
David Dias	442df13a11	feat: use next libp2p-crypto (#64 ) * feat: use next libp2p-crypto * chore: update deps	2017-07-22 13:37:01 -07:00