chore: release version v0.8.0

* refactor: make import and creation async - This allows the use of native key generation in the browser

BREAKING CHANGE:

This changes the interface of .create, .createFromPrivKey,
.createFromPubKey, .createFromJSON

.gitignore

@@ -25,3 +25,5 @@ build/Release
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+
+dist

.jshintignore

@@ -1 +0,0 @@
-node_modules

.jshintrc

@@ -1,10 +0,0 @@
-{
-  "node": true,
-
-  "curly": true,
-  "latedef": true,
-  "quotmark": true,
-  "undef": true,
-  "unused": true,
-  "trailing": true
-}

.npmignore

@@ -0,0 +1,28 @@
+# 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,13 +1,37 @@
+sudo: false
 language: node_js
-node_js:
-  - "4.0"
 
-branches:
-  only:
-    - master
+matrix:
+  include:
+  - node_js: 4
+    env: CXX=g++-4.8
+  - node_js: 6
+    env:
+      - SAUCE=true
+      - CXX=g++-4.8
+  - node_js: stable
+    env: CXX=g++-4.8
 
+# Make sure we have new NPM.
 before_install:
-  - npm i -g npm
-  # Workaround for a permissions issue with Travis virtual machine images
+  - npm install -g npm
+
 script:
+  - npm run lint
   - npm test
+  - npm run coverage
+
+before_script:
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+
+after_success:
+  - npm run coverage-publish
+
+addons:
+  firefox: latest
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8

README.md

@@ -1,66 +1,209 @@
-peer-id Node.js implementation
-==============================
+# 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/diasdavid/node-peer-id.svg?style=flat-square)](https://travis-ci.org/diasdavid/node-peer-id) ![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square) [![Dependency Status](https://david-dm.org/diasdavid/node-peer-id.svg?style=flat-square)](https://david-dm.org/diasdavid/node-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/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)
+[![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 Peer Id implementation in Node.js
+[![Sauce Test Status](https://saucelabs.com/browser-matrix/ipfs-js-peer-id.svg)](https://saucelabs.com/u/ipfs-js-peer-id)
+
+> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
+
+- [Description](#description)
+- [Example](#example)
+- [Installation](#installation)
+  - [npm](#npm)
+- [Setup](#setup)
+  - [Node.js](#nodejs)
+  - [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
+  - [Browser: `<script>` Tag](#browser-script-tag)
+- [API](#api)
+  - [Create](#create)
+    - [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
+    - [`create([opts], callback)`](#createopts-callback)
+  - [Import](#import)
+    - [`createFromHexString(str)`](#createfromhexstringstr)
+    - [`createFromBytes(buf)`](#createfrombytesbuf)
+    - [`createFromB58String(str)`](#createfromb58stringstr)
+    - [`createFromPubKey(pubKey)`](#createfrompubkeypubkey)
+    - [`createFromPrivKey(privKey)`](#createfromprivkeyprivkey)
+    - [`createFromJSON(obj)`](#createfromjsonobj)
+  - [Export](#export)
+    - [`toHexString()`](#tohexstring)
+    - [`toBytes()`](#tobytes)
+    - [`toB58String()`](#tob58string)
+    - [`toJSON()`](#tojson)
+    - [`toPrint()`](#toprint)
+- [License](#license)
 
 # Description
 
-A IPFS Peer Id is based on a sha256 has of the peer public key, using [multihash](https://github.com/jbenet/multihash)
+Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
 
-# Usage
+*A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a
+public key.*
 
-### Installing
+*The public key is a base64 encoded string of a protobuf containing an RSA DER
+buffer. This uses a node buffer to pass the base64 encoded public key protobuf
+to the multihash for ID generation.*
 
-```
-$ npm install peer-id
+# Example
+
+```js
+var PeerId = require('peer-id')
+var bs58 = require('bs58')
+
+PeerId.create({ bits: 1024 }, (err, id) => {
+  console.log(JSON.stringify(id.toJSON(), null, 2)
+})
 ```
 
-### Creating a new Id
-
 ```
-var PeerId = require('ipfs-peer')
-
-// Create a new Id
-var id = new PeerId.create()
-
-// Recreate an Id from Hex string
-var id = new PeerId.createFromHexString(str)
-
-// Recreate an Id from a Buffer
-var id = new PeerId.createFromBytes(buf)
-
-// Recreate an B58 String
-var id = new PeerId.createFromB58String(str)
-
-// Recreate from a Public Key
-var id = new PeerId.createFromPubKey(pubKey)
-
-// Recreate from a Private Key
-var id = new PeerId.createFromPrivKey(privKey)
+{
+  "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
+  "privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
+  "pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
+}
 ```
 
-### Exporting an Id
+# Installation
 
-```
-// Print friendly format
-id.toPrint() // returns an object with id, privKey and pubKey in hex format
+## npm
 
-// Export to an hex string
-id.toHexString()
-
-// Export to Buffer
-id.toBytes() (same as id.id)
-
-// Export to a B58 string
-id.toB58String()
+```sh
+> npm i peer-id
 ```
 
-### Id format
+# Setup
+
+## Node.js
+
+```js
+var PeerId = require('peer-id')
+```
+
+## Browser: Browserify, Webpack, other bundlers
+
+The code published to npm that gets loaded on require is in fact a ES5
+transpiled version with the right shims added. This means that you can require
+it and use with your favourite bundler without having to adjust asset management
+process.
+
+```js
+var PeerId = require('peer-id')
+```
+
+## Browser: `<script>` Tag
+
+Loading this module through a script tag will make the `PeerId` obj available in
+the global namespace.
+
+```html
+<script src="https://unpkg.com/peer-id/dist/index.min.js"></script>
+<!-- OR -->
+<script src="https://unpkg.com/peer-id/dist/index.js"></script>
+```
+
+# API
+
+```js
+const PeerId = require('peer-id')
+```
+
+## Create
+
+### `new PeerId(id[, privKey, pubKey])`
+
+- `id: Buffer` - The multihash of the publick 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)`
+
+Generates a new Peer ID, complete with public/private keypair.
+
+- `opts: Object`: Default: `{bits: 2048}`
+- `callback: Function`
+
+Calls back `callback` with `err, id`.
+
+## Import
+
+### `createFromHexString(str)`
+
+Creates a Peer ID from hex string representing the key's multihash.
+
+### `createFromBytes(buf)`
+
+Creates a Peer ID from a buffer representing the key's multihash.
+
+### `createFromB58String(str)`
+Creates a Peer ID from a Base58 string representing the key's multihash.
+
+### `createFromPubKey(pubKey)`
+
+- `publicKey: Buffer`
+
+Creates a Peer ID from a buffer containing a public key.
+
+### `createFromPrivKey(privKey)`
+
+- `privKey: Buffer`
+
+Creates a Peer ID from a buffer containing a private key.
+
+### `createFromJSON(obj)`
+
+- `obj.id: String` - The multihash encoded in `base58`
+- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
+- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
+
+## Export
+
+### `toHexString()`
+
+Returns the Peer ID's `id` as a hex string.
 
 ```
-id.pubKey   // Buffer containing the Public Key
-id.privKey  // Buffer containing the Private Key
-id.id       // Buffer containing the multihash
+1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
 ```
+
+### `toBytes()`
+
+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>
+```
+
+### `toB58String()`
+
+Returns the Peer ID's `id` as a base58 string.
+
+```
+QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
+```
+
+### `toJSON()`
+
+Returns an `obj` of the form
+
+- `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'
+
+
+### `toPrint()`
+
+Alias for `.toJSON()`.
+
+
+# License
+
+MIT

circle.yml

@@ -0,0 +1,12 @@
+machine:
+  node:
+    version: stable
+
+dependencies:
+  pre:
+    - google-chrome --version
+    - wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+    - sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+    - sudo apt-get update
+    - sudo apt-get --only-upgrade install google-chrome-stable
+    - google-chrome --version

package.json

@@ -1,14 +1,20 @@
 {
   "name": "peer-id",
-  "version": "0.3.3",
+  "version": "0.8.0",
   "description": "IPFS Peer Id implementation in Node.js",
   "main": "src/index.js",
+  "bin": "src/bin.js",
   "scripts": {
-    "test": "./node_modules/.bin/lab tests/*-test.js",
-    "coverage": "./node_modules/.bin/lab -t 100 tests/*-test.js",
-    "codestyle": "./node_modules/.bin/standard --format",
-    "lint": "jshint .",
-    "validate": "npm ls"
+    "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"
   },
   "keywords": [
     "IPFS"
@@ -16,24 +22,38 @@
   "author": "David Dias <daviddias@ipfs.io>",
   "license": "MIT",
   "pre-commit": [
-    "codestyle",
+    "lint",
     "test"
   ],
   "engines": {
-    "node": "^4.0.0"
+    "node": ">=4.0.0"
   },
   "bugs": {
-    "url": "https://github.com/diasdavid/node-peer-id/issues"
+    "url": "https://github.com/libp2p/js-peer-id/issues"
   },
-  "homepage": "https://github.com/diasdavid/node-peer-id",
+  "homepage": "https://github.com/libp2p/js-peer-id",
   "devDependencies": {
-    "code": "^1.4.1",
-    "lab": "^5.13.0",
-    "pre-commit": "^1.1.1",
-    "standard": "^4.5.2"
+    "aegir": "^9.0.1",
+    "chai": "^3.5.0",
+    "pre-commit": "^1.1.3"
   },
   "dependencies": {
-    "bs58": "^2.0.1",
-    "multihashing": "^0.1.3"
-  }
-}
+    "async": "^2.0.1",
+    "libp2p-crypto": "^0.7.0",
+    "multihashes": "^0.2.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/libp2p/js-peer-id.git"
+  },
+  "contributors": [
+    "David Dias <daviddias.p@gmail.com>",
+    "David Dias <mail@daviddias.me>",
+    "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Richard Littauer <richard.littauer@gmail.com>",
+    "Stephen Whitmore <stephen.whitmore@gmail.com>",
+    "greenkeeperio-bot <support@greenkeeper.io>",
+    "nginnever <ginneversource@gmail.com>",
+    "npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>"
+  ]
+}

src/bin.js

@@ -0,0 +1,13 @@
+#!/usr/local/bin/node
+
+'use strict'
+
+const PeerId = require('./index.js')
+
+PeerId.create((err, id) => {
+  if (err) {
+    throw err
+  }
+
+  console.log(JSON.stringify(id.toJSON(), null, 2))
+})

src/index.js

@@ -2,77 +2,216 @@
  * Id is an object representation of a peer Id. a peer Id is a multihash
  */
 
-var multihashing = require('multihashing')
-var base58 = require('bs58')
-var crypto = require('crypto')
+'use strict'
 
-exports = module.exports = Id
+const mh = require('multihashes')
+const crypto = require('libp2p-crypto')
+const assert = require('assert')
+const waterfall = require('async/waterfall')
 
-function Id (id, privKey, pubKey) {
-  var self = this
+class PeerId {
+  constructor (id, privKey, pubKey) {
+    assert(Buffer.isBuffer(id), 'invalid id provided')
 
-  if (!(self instanceof Id)) {
-    throw new Error('Id must be called with new')
+    if (privKey && pubKey) {
+      assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
+    }
+
+    this.id = id
+    this._privKey = privKey
+    this._pubKey = pubKey
   }
 
-  self.privKey = privKey
-  self.pubKey = pubKey
-  self.id = id // multihash - sha256 - buffer
+  get privKey () {
+    return this._privKey
+  }
+
+  get pubKey () {
+    if (this._pubKey) {
+      return this._pubKey
+    }
+
+    if (this.privKey) {
+      return this.privKey.public
+    }
+  }
+
+  // Return the protobuf version of the public key,
+  // matching go ipfs formatting
+  marshalPubKey () {
+    if (this.pubKey) {
+      return crypto.marshalPublicKey(this.pubKey)
+    }
+  }
+
+  // Return the protobuf version of the private key,
+  // matching go ipfs formatting
+  marshalPrivKey () {
+    if (this.privKey) {
+      return crypto.marshalPrivateKey(this.privKey)
+    }
+  }
 
   // pretty print
+  toPrint () {
+    return this.toJSON()
+  }
 
-  self.toPrint = function () {
+  // return the jsonified version of the key, matching the formatting
+  // of go-ipfs for its config file
+  toJSON () {
     return {
-      id: id.toHexString(),
-      privKey: privKey.toString('hex'),
-      pubKey: pubKey.toString('hex')
+      id: mh.toB58String(this.id),
+      privKey: toB64Opt(this.marshalPrivKey()),
+      pubKey: toB64Opt(this.marshalPubKey())
     }
   }
 
   // encode/decode functions
-
-  self.toHexString = function () {
-    return self.id.toString('hex')
+  toHexString () {
+    return mh.toHexString(this.id)
   }
 
-  self.toBytes = function () {
-    return self.id
+  toBytes () {
+    return this.id
   }
 
-  self.toB58String = function () {
-    return base58.encode(self.id)
+  toB58String () {
+    return mh.toB58String(this.id)
   }
-
 }
 
+exports = module.exports = PeerId
+exports.Buffer = Buffer
+
 // generation
+exports.create = function (opts, callback) {
+  if (typeof opts === 'function') {
+    callback = opts
+    opts = {}
+  }
+  opts = opts || {}
+  opts.bits = opts.bits || 2048
 
-exports.create = function () {
-  var ecdh = crypto.createECDH('secp256k1')
-  ecdh.generateKeys()
+  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)
+    }
 
-  var mhId = multihashing(ecdh.getPublicKey(), 'sha2-256')
-
-  return new Id(mhId, ecdh.getPrivateKey(), ecdh.getPublicKey())
+    callback(null, new PeerId(digest, privKey))
+  })
 }
 
 exports.createFromHexString = function (str) {
-  return new Id(new Buffer(str), 'hex')
+  return new PeerId(mh.fromHexString(str))
 }
 
 exports.createFromBytes = function (buf) {
-  return new Id(buf)
+  return new PeerId(buf)
 }
 
 exports.createFromB58String = function (str) {
-  return new Id(new Buffer(base58.decode(str)))
+  return new PeerId(mh.fromB58String(str))
 }
 
-exports.createFromPubKey = function (pubKey) {
-  var mhId = multihashing(pubKey, 'sha2-256')
-  return new Id(mhId, null, pubKey)
+// Public Key input will be a buffer
+exports.createFromPubKey = function (key, callback) {
+  let buf = key
+  if (typeof buf === 'string') {
+    buf = new Buffer(key, 'base64')
+  }
+
+  if (typeof callback !== 'function') {
+    throw new Error('callback is required')
+  }
+
+  const pubKey = crypto.unmarshalPublicKey(buf)
+  pubKey.hash((err, digest) => {
+    if (err) {
+      return callback(err)
+    }
+
+    callback(null, new PeerId(digest, null, pubKey))
+  })
 }
 
-exports.createFromPrivKey = function () {
-  // TODO(daviddias) derive PubKey from priv
+// Private key input will be a string
+exports.createFromPrivKey = function (key, callback) {
+  let buf = key
+  if (typeof buf === 'string') {
+    buf = new Buffer(key, 'base64')
+  }
+
+  if (typeof callback !== 'function') {
+    throw new Error('callback is required')
+  }
+
+  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))
+  })
+}
+
+exports.createFromJSON = function (obj, callback) {
+  if (typeof callback !== 'function') {
+    throw new Error('callback is required')
+  }
+
+  const id = mh.fromB58String(obj.id)
+  const rawPrivKey = obj.privKey && new Buffer(obj.privKey, 'base64')
+  const rawPubKey = obj.pubKey && new Buffer(obj.pubKey, 'base64')
+  const pub = rawPubKey && crypto.unmarshalPublicKey(rawPubKey)
+
+  if (rawPrivKey) {
+    waterfall([
+      (cb) => crypto.unmarshalPrivateKey(rawPrivKey, cb),
+      (priv, cb) => priv.public.hash((err, digest) => {
+        cb(err, digest, priv)
+      }),
+      (privDigest, priv, cb) => {
+        if (pub) {
+          pub.hash((err, pubDigest) => {
+            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))
+  }
+}
+
+function toB64Opt (val) {
+  if (val) {
+    return val.toString('base64')
+  }
 }

test/fixtures/go-private-key.js

@@ -0,0 +1,6 @@
+'use strict'
+
+module.exports = {
+  id: 'QmRLoXS3E73psYaUsma1VSbboTa2J8Z9kso1tpiGLk9WQ4',
+  privKey: 'CAASpwkwggSjAgEAAoIBAQDWBEbO8kc6a5kEks09CKPQargY3p0DCmCczoCT52/RYFqxvH9dI+s+u4ZAvF9aLWOBvFomL7jHZODPxKDrbiNCmyEbViNgZYK+PNbwh0V3ZGbB27X3q8yZtLvYA8dhcNkz/2SHBarSoC4QLA5MXUuSWtVaYMY3MzMnzBF57Jc9Ase7NvHOIUI90M7aN5izP7hxPXpZ+shiN+TyjM8mFxYONG7ZSsY3IxUhtrU5MRzFX+tp1o/gb/aa51mHf7AL3N02j5ABiYbCK97Rbwr03hsBcwgMxoDPJmP3WZ+D5yyPcOIIF1Vd7+4/f7FQJnIw3xr9/jvaFbPyDCVbBOhr9oyxAgMBAAECggEALlrgx2Q8v0+c5hux7p1XdgYXd/OHyKfPw0cLHH4NfylCm6q7X34vLvhJHO5wLMUV/3y/ffPqLu4Pr5DkVfoWExAsvJIMuY1jIzdkStbR2glaJHUlVc7VUxmNcj1nSxi5QwT3TjORC2v8bi5Mroeqnbmk6p15cW1akC0oP+NZ4rG48+WFHRqsBaBusdSOVfA+IiZUqSd1ILysJ1w7aVN3EC7jLjDG43i+P/2BcEHy8TVClGOknJL341bHe3UPdEpmeu6k6aHGlDI4blUMXahCIUh0IdZuj+Vi/TxQME9+3bKIOjQb8RCNm3U3j/uz5gs9SyTjBuYIib9Scj/jDbLh0QKBgQDfLr3go3Q/AR0jb12QjGALJz1lc9ZRX2RQJkqqmYkZwOlHHyl+YJgqOZiO80fUkN0sJ29CmKecXU4gXuHir913Fdceei1ScBSsvZpWtBLhEZXKrRJYq8U0atKUFQADDMGutyB/uGCNeNwR6VcJezHPICvHxQfmWlWHA5VIOEtRPQKBgQD1fID76SkIpF/EaJMnN2alXWWnzKhUBUPGpQtbpwgSfaCBiZ4vr3NQwKBntOOB5QwHmifNZMoqaFQLzC4B/uyTNUcQMQQ6arYav7WQXqXTmW6poTsjUSuSOPx1swsHlYX09SmUwWDfd94XF9UOU0KUfA2/c85ixzNlV5ejkFA4hQKBgEvP3uQN4hD82d8Nl2TgqkdfnvV1cdnWY4buWvK0kOPUqelk5n1tZoMBaZc1gLLuOpMjGiIvJNByyXUpheWxA7POEXLi4b5dIEjFZ0YIiVk21gEw5UiFoMl7d+ihcY2Xqbslrb507SdhZLAY6V3pITRQo06K2XIgQWlJiE4uATepAoGBALZ2vEiBnYZW5vfN4tKbUyhGq3B1pggNgbr8odyV4mIcDlk6OOGov0WeZ5ut0AyUesSLyFnaOIoc0ZuTP/8rxBwG1bMrO8FP39sx83pDX25P9PkQZixyALjGsp+pXOFeOhtAvo9azO5M4j638Bydtjc3neBX62dwOLtyx7tDYN0hAoGAVLmr3w7XMVHTfEuCSzKHyRrOaN2PAuSX31QAji1PwlwVKMylVrb8rRvBOpTicA/wXPX9Q5O/yjegqhqLT/LXAm9ziFzy5b9/9SzXPukKebXXbvc0FOmcsrcxtijlPyUzf9fKM1ShiwqqsgM9eNyZ9GWUJw2GFATCWW7pl7rtnWk='
+}

test/fixtures/sample-id.js

@@ -0,0 +1,7 @@
+'use strict'
+
+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='
+}

test/index.spec.js

@@ -0,0 +1,225 @@
+/* eslint max-nested-callbacks: ["error", 8] */
+/* eslint-env mocha */
+'use strict'
+
+const expect = require('chai').expect
+const crypto = require('libp2p-crypto')
+const mh = require('multihashes')
+const parallel = require('async/parallel')
+
+const PeerId = require('../src')
+
+const testId = require('./fixtures/sample-id')
+const testIdHex = testId.id
+const testIdBytes = mh.fromHexString(testId.id)
+const testIdB58String = mh.toB58String(testIdBytes)
+
+const goId = require('./fixtures/go-private-key')
+
+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('recreate an Id from Hex string', () => {
+    const id = PeerId.createFromHexString(testIdHex)
+    expect(testIdBytes).to.deep.equal(id.id)
+  })
+
+  it('Recreate an Id from a Buffer', () => {
+    const id = PeerId.createFromBytes(testIdBytes)
+    expect(testId.id).to.equal(id.toHexString())
+  })
+
+  it('Recreate a B58 String', () => {
+    const id = PeerId.createFromB58String(testIdB58String)
+    expect(testIdB58String).to.equal(id.toB58String())
+  })
+
+  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 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('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('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('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('toBytes', () => {
+    const id = PeerId.createFromHexString(testIdHex)
+    expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
+  })
+
+  describe('fromJSON', () => {
+    it('full node', (done) => {
+      PeerId.create({bits: 1024}, (err, id) => {
+        expect(err).to.not.exist
+
+        PeerId.createFromJSON(id.toJSON(), (err, other) => {
+          expect(err).to.not.exist
+          expect(
+            id.toB58String()
+          ).to.equal(
+            other.toB58String()
+          )
+          expect(
+            id.privKey.bytes
+          ).to.deep.equal(
+            other.privKey.bytes
+          )
+          expect(
+            id.pubKey.bytes
+          ).to.deep.equal(
+            other.pubKey.bytes
+          )
+          done()
+        })
+      })
+    })
+
+    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()
+        })
+      })
+    })
+  })
+
+  describe('throws on inconsistent data', () => {
+    let k1, k2, k3
+    before((done) => {
+      parallel([
+        (cb) => crypto.generateKeyPair('RSA', 1024, cb),
+        (cb) => crypto.generateKeyPair('RSA', 1024, cb),
+        (cb) => crypto.generateKeyPair('RSA', 1024, cb)
+      ], (err, keys) => {
+        if (err) {
+          return done(err)
+        }
+
+        k1 = keys[0]
+        k2 = keys[1]
+        k3 = keys[2]
+        done()
+      })
+    })
+
+    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 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('invalid id', () => {
+      expect(
+        () => new PeerId('hello world')
+      ).to.throw(
+        /invalid id/
+      )
+    })
+  })
+})