chore: release version v0.10.0

* chore: update deps

* chore: update gitignore

* chore: update CI

* chore: update README badge

.gitignore

@@ -1,7 +1,14 @@
+**/node_modules/
+**/*.log
+test/repo-tests*
+**/bundle.js
+
 # Logs
 logs
 *.log
 
+coverage
+
 # Runtime data
 pids
 *.pid
@@ -19,12 +26,17 @@ 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
 
+lib
 dist
-docs
+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

.travis.yml

@@ -3,23 +3,18 @@ language: node_js
 
 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 install -g npm
+  - node_js: 8
+    env: CXX=g++-4.8
+    #  - node_js: stable
+    #    env: CXX=g++-4.8
 
 script:
   - npm run lint
-  - npm test
+  - npm run test
   - npm run coverage
+  - make test
 
 before_script:
   - export DISPLAY=:99.0
@@ -29,7 +24,7 @@ after_success:
   - npm run coverage-publish
 
 addons:
-  firefox: latest
+  firefox: 'latest'
   apt:
     sources:
       - ubuntu-toolchain-r-test

README.md

@@ -7,9 +7,7 @@
 [![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)
-
-[![Sauce Test Status](https://saucelabs.com/browser-matrix/ipfs-js-peer-id.svg)](https://saucelabs.com/u/ipfs-js-peer-id)
+![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
 
 > [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
 
@@ -22,30 +20,43 @@
   - [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
 
 Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
 
-*A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a
-public key.*
+A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a public key.
 
-*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.*
+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.
 
 # Example
 
-```js
-var PeerId = require('peer-id')
+```JavaScript
+const PeerId = require('peer-id')
 
 PeerId.create({ bits: 1024 }, (err, id) => {
-  console.log(JSON.stringify(id.toJSON(), null, 2)
+  if (err) { throw err }
+  console.log(JSON.stringify(id.toJSON(), null, 2))
 })
 ```
-
-```
+```bash
 {
   "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
   "privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
@@ -66,7 +77,7 @@ PeerId.create({ bits: 1024 }, (err, id) => {
 ## Node.js
 
 ```js
-var PeerId = require('peer-id')
+const PeerId = require('peer-id')
 ```
 
 ## Browser: Browserify, Webpack, other bundlers
@@ -77,7 +88,7 @@ it and use with your favourite bundler without having to adjust asset management
 process.
 
 ```js
-var PeerId = require('peer-id')
+const PeerId = require('peer-id')
 ```
 
 ## Browser: `<script>` Tag
@@ -93,6 +104,103 @@ the global namespace.
 
 # 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.
+
+```
+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()`.
+
+### `isEqual(id)`
+
+- `id` can be a PeerId or a Buffer containing the id
+
 # License
 
 MIT

circle.yml

@@ -5,8 +5,10 @@ machine:
 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'
+    - 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 --only-upgrade install google-chrome-stable
+    - sudo apt-get install -f
+    - sudo apt-get install --only-upgrade lsb-base
+    - sudo dpkg -i google-chrome.deb
     - google-chrome --version

documentation.yml

@@ -1,5 +0,0 @@
-toc:
-  - name: Introduction
-    file: intro.md
-  - PeerId
-  - PeerIdJson

intro.md

@@ -1,61 +0,0 @@
-Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
-
-> A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a public key.
->
-> 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.
-
-## Example
-
-```js
-var PeerId = require('peer-id')
-
-PeerId.create({ bits: 1024 }, (err, id) => {
-  console.log(JSON.stringify(id.toJSON(), null, 2)
-})
-```
-
-```json
-{
-  "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
-  "privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
-  "pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
-}
-```
-
-## Installation
-
-### npm
-
-```sh
-> npm i peer-id
-```
-
-## 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>
-```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "peer-id",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "IPFS Peer Id implementation in Node.js",
   "main": "src/index.js",
   "bin": "src/bin.js",
@@ -14,8 +14,7 @@
     "release-minor": "aegir-release --type minor",
     "release-major": "aegir-release --type major",
     "coverage": "aegir-coverage",
-    "coverage-publish": "aegir-coverage publish",
-    "docs": "aegir-docs"
+    "coverage-publish": "aegir-coverage publish"
   },
   "keywords": [
     "IPFS"
@@ -27,21 +26,24 @@
     "test"
   ],
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=6.0.0",
+    "npm": ">=3.0.0"
   },
   "bugs": {
     "url": "https://github.com/libp2p/js-peer-id/issues"
   },
   "homepage": "https://github.com/libp2p/js-peer-id",
   "devDependencies": {
-    "aegir": "^9.1.2",
-    "chai": "^3.5.0",
-    "pre-commit": "^1.1.3"
+    "aegir": "^11.0.2",
+    "chai": "^4.1.2",
+    "dirty-chai": "^2.0.1",
+    "pre-commit": "^1.2.2"
   },
   "dependencies": {
-    "async": "^2.0.1",
-    "libp2p-crypto": "^0.7.0",
-    "multihashes": "^0.3.0"
+    "async": "^2.5.0",
+    "libp2p-crypto": "~0.9.4",
+    "lodash": "^4.17.4",
+    "multihashes": "~0.4.9"
   },
   "repository": {
     "type": "git",
@@ -51,10 +53,11 @@
     "David Dias <daviddias.p@gmail.com>",
     "David Dias <mail@daviddias.me>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Prashanth Chandra <coolshanth94@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/index.js

@@ -1,32 +1,16 @@
+/*
+ * Id is an object representation of a peer Id. a peer Id is a multihash
+ */
+
 'use strict'
 
 const mh = require('multihashes')
 const crypto = require('libp2p-crypto')
 const assert = require('assert')
 const waterfall = require('async/waterfall')
+const Buffer = require('safe-buffer').Buffer
 
-/**
- * @name PeerIdJson
- * @type {Object}
- * @typedef {Object} PeerIdJson
- * @param {string} id - `Base58` encoded peer id
- * @param {string=} privKey - The RSA private key in protobuf format, encoded in `base64`.
- * @param {string=} pubKey - The RSA public key in protobuf format, encoded in `base64`.
- */
-
-/**
- * A Peer ID is the SHA-256
- * [multihash](https://github.com/multiformats/multihash) of a
- * public key.
- * @class PeerId
- * @see [libp2p-crypto](htttps://github.com/libp2p/js-libp2p-crypto)
- */
 class PeerId {
-  /**
-   * @param {Buffer} id
-   * @param {RSAPrivateKey=} privKey
-   * @param {RSAPublickKey=} pubKey
-   */
   constructor (id, privKey, pubKey) {
     assert(Buffer.isBuffer(id), 'invalid id provided')
 
@@ -34,306 +18,248 @@ class PeerId {
       assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
     }
 
-    /**
-     * @type {Buffer}
-     */
-    this.id = id
+    this._id = id
+    this._idB58String = mh.toB58String(this.id)
     this._privKey = privKey
     this._pubKey = pubKey
   }
 
-  /**
-   * The private key of this id, if it exists.
-   *
-   * @type {RSAPrivateKey|undefined}
-   */
+  get id () {
+    return this._id
+  }
+
+  set id (val) {
+    throw new Error('Id is immutable')
+  }
+
   get privKey () {
     return this._privKey
   }
 
-  /**
-   * The public key of this id, if it exists.
-   *
-   * @type {(RSAPublicKey|undefined)}
-   */
+  set privKey (privKey) {
+    this._privKey = privKey
+  }
+
   get pubKey () {
     if (this._pubKey) {
       return this._pubKey
     }
 
-    if (this.privKey) {
-      return this.privKey.public
+    if (this._privKey) {
+      return this._privKey.public
     }
   }
 
-  /** Create the protobuf version of the public key,
-   *  matching go-ipfs formatting.
-   *
-   * @returns {Buffer} - The marshalled public key
-   */
+  set pubKey (pubKey) {
+    this._pubKey = pubKey
+  }
+
+  // Return the protobuf version of the public key, matching go ipfs formatting
   marshalPubKey () {
     if (this.pubKey) {
-      return crypto.marshalPublicKey(this.pubKey)
+      return crypto.keys.marshalPublicKey(this.pubKey)
     }
   }
 
-  /** Create the protobuf version of the private key,
-   *  matching go-ipfs formatting.
-   *
-   * @returns {Buffer}
-   */
+  // Return the protobuf version of the private key, matching go ipfs formatting
   marshalPrivKey () {
     if (this.privKey) {
-      return crypto.marshalPrivateKey(this.privKey)
+      return crypto.keys.marshalPrivateKey(this.privKey)
     }
   }
 
-  /**
-   * Alias for `toJSON`.
-   *
-   * @returns {PeerIdJson}
-   */
+  // pretty print
   toPrint () {
     return this.toJSON()
   }
 
-  /**
-   * Return the jsonified version of the key, matching the formatting
-   * of go-ipfs for its config file.
-   *
-   * @returns {PeerIdJson}
-   */
+  // return the jsonified version of the key, matching the formatting
+  // of go-ipfs for its config file
   toJSON () {
     return {
-      id: mh.toB58String(this.id),
+      id: this.toB58String(),
       privKey: toB64Opt(this.marshalPrivKey()),
       pubKey: toB64Opt(this.marshalPubKey())
     }
   }
 
-  /**
-   * Returns the Peer ID's `id` as a hex string.
-   *
-   * @returns {String}
-   */
+  // encode/decode functions
   toHexString () {
     return mh.toHexString(this.id)
   }
 
-  /**
-   * Returns the Peer ID's `id` as a buffer.
-   *
-   * @returns {Buffer}
-   */
   toBytes () {
     return this.id
   }
 
-  /**
-   * Returns the Peer ID's `id` as a base58 string.
-   *
-   * @returns {String}
-   */
   toB58String () {
-    return mh.toB58String(this.id)
+    return this._idB58String
   }
 
-  /**
-   * Create a new `PeerId` by generating a new public/private keypair.
-   *
-   * @param {Object=} opts - Configuration object.
-   * @param {number} [opts.bits=2048] - How many bits to use for the RSA key generation.
-   * @param {function(Error, PeerId)} callback - Node.js style callback.
-   * @returns {undefined}
-   *
-   * @example
-   * const PeerId = require('peer-id')
-   *
-   * PeerId.create((err, id) => {
-   *   if (err) {
-   *     throw err
-   *   }
-   *   console.log('id', JSON.stringify(id))
-   * })
-   *
-   */
-  static create (opts, callback) {
-    if (typeof opts === 'function') {
-      callback = opts
-      opts = {}
-    }
-    opts = opts || {}
-    opts.bits = opts.bits || 2048
-
-    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))
-    })
-  }
-
-  /**
-   * Creates a Peer ID from hex string representing the key's multihash.
-   *
-   * @param {string} str - Hex encoded id
-   * @returns {PeerId}
-   */
-  static createFromHexString (str) {
-    return new PeerId(mh.fromHexString(str))
-  }
-
-  /**
-   * Creates a Peer ID from a buffer representing the key's multihash.
-   *
-   * @param {Buffer} buf
-   * @returns {PeerId}
-   */
-  static createFromBytes (buf) {
-    return new PeerId(buf)
-  }
-
-  /**
-   * Creates a Peer ID from a `base58` string representing the
-   * key's multihash.
-   *
-   * @param {string} str - `base58` encoded id
-   * @returns {PeerId}
-   */
-  static createFromB58String (str) {
-    return new PeerId(mh.fromB58String(str))
-  }
-
-  /**
-   * Creates a Peer ID from a buffer containing a public key.
-   *
-   * @param {string|Buffer} key
-   * @param {function(Error, PeerId)} callback
-   * @returns {undefined}
-   */
-  static createFromPubKey (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))
-    })
-  }
-
-  /**
-   * Creates a Peer ID from a buffer containing a private key.
-   *
-   * @param {string|Buffer} key - The private key, if passed as
-   *   string `base64` encoding is assumed.
-   * @param {function(Error, PeerId)} callback
-   * @returns {undefined}
-   */
-  static createFromPrivKey (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))
-    })
-  }
-
-  /**
-   * Import a `PeerId` from a serialized JSON object.
-   *
-   * @param {PeerIdJson} obj
-   * @param {function(Error, PeerId)} callback
-   * @returns {undefined}
-   */
-  static createFromJSON (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))
-      })
+  isEqual (id) {
+    if (Buffer.isBuffer(id)) {
+      return this.id.equals(id)
+    } else if (id.id) {
+      return this.id.equals(id.id)
     } else {
-      callback(null, new PeerId(id, null, pub))
+      throw new Error('not valid Id')
+    }
+  }
+
+  /*
+   * Check if this PeerId instance is valid (privKey -> pubKey -> Id)
+   */
+  isValid (callback) {
+    // TODO Needs better checking
+    if (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'))
     }
   }
 }
 
-/**
- * Convert a given `Buffer` to a `base64` encoded string.
- * If no `val` is given it just returns `undefined`.
- *
- * @private
- * @param {Buffer=} val
- * @returns {string|undefined}
- */
+exports = module.exports = PeerId
+
+// generation
+exports.create = function (opts, callback) {
+  if (typeof opts === 'function') {
+    callback = opts
+    opts = {}
+  }
+  opts = opts || {}
+  opts.bits = opts.bits || 2048
+
+  waterfall([
+    (cb) => crypto.keys.generateKeyPair('RSA', opts.bits, cb),
+    (privKey, cb) => privKey.public.hash((err, digest) => {
+      cb(err, digest, privKey)
+    })
+  ], (err, digest, privKey) => {
+    if (err) {
+      return callback(err)
+    }
+
+    callback(null, new PeerId(digest, privKey))
+  })
+}
+
+exports.createFromHexString = function (str) {
+  return new PeerId(mh.fromHexString(str))
+}
+
+exports.createFromBytes = function (buf) {
+  return new PeerId(buf)
+}
+
+exports.createFromB58String = function (str) {
+  return new PeerId(mh.fromB58String(str))
+}
+
+// Public Key input will be a buffer
+exports.createFromPubKey = function (key, callback) {
+  if (typeof callback !== 'function') {
+    throw new Error('callback is required')
+  }
+
+  let buf = key
+  if (typeof buf === 'string') {
+    buf = Buffer.from(key, 'base64')
+  }
+
+  const pubKey = crypto.keys.unmarshalPublicKey(buf)
+
+  pubKey.hash((err, digest) => {
+    if (err) {
+      return callback(err)
+    }
+
+    callback(null, new PeerId(digest, null, pubKey))
+  })
+}
+
+// Private key input will be a string
+exports.createFromPrivKey = function (key, callback) {
+  let buf = key
+  if (typeof buf === 'string') {
+    buf = Buffer.from(key, 'base64')
+  }
+
+  if (typeof callback !== 'function') {
+    throw new Error('callback is required')
+  }
+
+  waterfall([
+    (cb) => crypto.keys.unmarshalPrivateKey(buf, cb),
+    (privKey, cb) => privKey.public.hash((err, digest) => {
+      cb(err, digest, privKey)
+    })
+  ], (err, digest, privKey) => {
+    if (err) {
+      return callback(err)
+    }
+
+    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 && Buffer.from(obj.privKey, 'base64')
+  const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
+  const pub = rawPubKey && crypto.keys.unmarshalPublicKey(rawPubKey)
+
+  if (rawPrivKey) {
+    waterfall([
+      (cb) => crypto.keys.unmarshalPrivateKey(rawPrivKey, cb),
+      (priv, cb) => priv.public.hash((err, digest) => {
+        cb(err, digest, priv)
+      }),
+      (privDigest, priv, cb) => {
+        if (pub) {
+          pub.hash((err, pubDigest) => {
+            cb(err, privDigest, priv, pubDigest)
+          })
+        } else {
+          cb(null, privDigest, priv)
+        }
+      }
+    ], (err, privDigest, priv, pubDigest) => {
+      if (err) {
+        return callback(err)
+      }
+
+      if (pub && !privDigest.equals(pubDigest)) {
+        return callback(new Error('Public and private key do not match'))
+      }
+
+      if (id && !privDigest.equals(id)) {
+        return callback(new Error('Id and private key do not match'))
+      }
+
+      callback(null, new PeerId(id, priv, pub))
+    })
+  } else {
+    callback(null, new PeerId(id, null, pub))
+  }
+}
+
+exports.isPeerId = function (peerId) {
+  return Boolean(typeof peerId === 'object' &&
+    peerId._id &&
+    peerId._idB58String)
+}
+
 function toB64Opt (val) {
   if (val) {
     return val.toString('base64')
   }
 }
-
-exports = module.exports = PeerId

test/index.spec.js

@@ -1,225 +0,0 @@
-/* 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/
-      )
-    })
-  })
-})

test/peer-id.spec.js

@@ -0,0 +1,273 @@
+/* eslint max-nested-callbacks: ["error", 8] */
+/* eslint-env mocha */
+'use strict'
+
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+chai.use(dirtyChai)
+const expect = chai.expect
+const crypto = require('libp2p-crypto')
+const mh = require('multihashes')
+const parallel = require('async/parallel')
+const Buffer = require('safe-buffer').Buffer
+
+const 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('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(Buffer.from('batatas'))).to.equal(false)
+      done()
+    })
+  })
+
+  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 = Buffer.from('hello')
+      }).to.throw(/immutable/)
+      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 = Buffer.from(testId.privKey, 'base64')
+      PeerId.createFromPrivKey(encoded, (err, id2) => {
+        expect(err).to.not.exist()
+        expect(testIdB58String).to.equal(id2.toB58String())
+        done()
+      })
+    })
+  })
+
+  it('Compare generated ID with one created from PubKey', (done) => {
+    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'))
+  })
+
+  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()
+    })
+  })
+
+  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.eql(other.privKey.bytes)
+          expect(id.pubKey.bytes).to.eql(other.pubKey.bytes)
+          done()
+        })
+      })
+    })
+
+    it('only id', (done) => {
+      crypto.keys.generateKeyPair('RSA', 1024, (err, key) => {
+        expect(err).to.not.exist()
+        key.public.hash((err, digest) => {
+          expect(err).to.not.exist()
+
+          const id = PeerId.createFromBytes(digest)
+          expect(id.privKey).to.not.exist()
+          expect(id.pubKey).to.not.exist()
+
+          PeerId.createFromJSON(id.toJSON(), (err, other) => {
+            expect(err).to.not.exist()
+            expect(id.toB58String()).to.equal(other.toB58String())
+            done()
+          })
+        })
+      })
+    })
+
+    it('go interop', (done) => {
+      PeerId.createFromJSON(goId, (err, id) => {
+        expect(err).to.not.exist()
+        id.privKey.public.hash((err, digest) => {
+          expect(err).to.not.exist()
+          expect(mh.toB58String(digest)).to.eql(goId.id)
+          done()
+        })
+      })
+    })
+  })
+
+  it('set privKey (valid)', (done) => {
+    PeerId.create((err, peerId) => {
+      expect(err).to.not.exist()
+      peerId.privKey = peerId._privKey
+      peerId.isValid(done)
+    })
+  })
+
+  it('set pubKey (valid)', (done) => {
+    PeerId.create((err, peerId) => {
+      expect(err).to.not.exist()
+      peerId.pubKey = peerId._pubKey
+      peerId.isValid(done)
+    })
+  })
+
+  it('set privKey (invalid)', (done) => {
+    PeerId.create((err, peerId) => {
+      expect(err).to.not.exist()
+      peerId.privKey = Buffer.from('bufff')
+      peerId.isValid((err) => {
+        expect(err).to.exist()
+        done()
+      })
+    })
+  })
+
+  it('set pubKey (invalid)', (done) => {
+    PeerId.create((err, peerId) => {
+      expect(err).to.not.exist()
+      peerId.pubKey = Buffer.from('buffff')
+      peerId.isValid((err) => {
+        expect(err).to.exist()
+        done()
+      })
+    })
+  })
+
+  describe('throws on inconsistent data', () => {
+    let k1
+    let k2
+    let k3
+
+    before((done) => {
+      parallel([
+        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
+        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb),
+        (cb) => crypto.keys.generateKeyPair('RSA', 1024, cb)
+      ], (err, keys) => {
+        expect(err).to.not.exist()
+
+        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/)
+    })
+  })
+})