chore: release version v0.7.0

refactor: use libp2p and standardized rsa keys

.aegir.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const path = require('path')
+
+module.exports = {
+  webpack: {
+    resolve: {
+      alias: {
+        'node-forge': path.resolve(
+          path.dirname(require.resolve('libp2p-crypto')),
+          '../vendor/forge.bundle.js'
+        )
+      }
+    }
+  }
+}

.gitignore

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

.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,14 +1,18 @@
+sudo: false
 language: node_js
 node_js:
-  - "4.0"
-
-branches:
-  only:
-    - master
+  - 4
+  - 5
+  - stable
 
+# 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
 
 addons:
   firefox: 'latest'
@@ -17,5 +21,5 @@ before_script:
   - export DISPLAY=:99.0
   - sh -e /etc/init.d/xvfb start
 
-script:
-  - npm test
+after_success:
+  - npm run coverage-publish

README.md

@@ -1,93 +1,172 @@
-peer-id JavaScript 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/js-peer-id.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-peer-id)
-![](https://img.shields.io/badge/coverage-95%25-yellow.svg?style=flat-square)
+[![Coverage Status](https://coveralls.io/repos/github/diasdavid/js-peer-id/badge.svg?branch=master)](https://coveralls.io/github/diasdavid/js-peer-id?branch=master)
 [![Dependency Status](https://david-dm.org/diasdavid/js-peer-id.svg?style=flat-square)](https://david-dm.org/diasdavid/js-peer-id)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
-> IPFS Peer Id implementation in JavaScript
+
+> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
 
 # Description
 
-An IPFS Peer Id is based on a sha256 hash 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).
 
-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. 
+*A Peer ID is the SHA-256 [multihash](https://github.com/jbenet/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.*
 
-# Usage
+# Example
 
-### In Node.js through npm
+```js
+var PeerId = require('peer-id')
+var bs58 = require('bs58')
 
-```bash
-> npm install --save peer-id
+var id = PeerId.create({ bits: 32 })
+
+console.log('id        ', id.toB58String())
+console.log('priv key  ', bs58.encode(id.privKey.bytes))
+console.log('pub key   ', bs58.encode(id.pubKey.bytes))
 ```
 
-```javascript
+```
+id         QmeeLFb92nkZJGj3gXLqXrEMzCMYs6uBgQLVNbrcXEvYXk
+priv key   6ibrcPAbevzvPpkq6EA6XmLyuhmUrJrEvUfgQDtEiSEPzGnGU8Ejwf6b11DVm6opnFGo
+pub key    2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE
+```
+
+# 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://npmcdn.com/peer-id/dist/index.min.js"></script>
+<!-- OR -->
+<script src="https://npmcdn.com/peer-id/dist/index.js"></script>
+```
+
+# API
+
+```js
 const PeerId = require('peer-id')
 ```
 
-### In the Browser through browserify
+## Create
 
-Same as in Node.js, you just have to [browserify](https://github.com/substack/node-browserify) the code before serving it. See the browserify repo for how to do that.
+### `new PeerId(id[, privKey, pubKey])`
 
-### In the Browser through `<script>` tag
+- `id: Buffer` - The multihash of the publick key as `Buffer`
+- `privKey: RsaPrivateKey` - The private key
+- `pubKey: RsaPublicKey` - The public key
 
-Make the [peer-id.min.js](/dist/peer-id.min.js) available through your server and load it using a normal `<script>` tag, this will export the `peerId` constructor on the `window` object, such that:
+The key format is detailed in [libp2p-crypto](https://github.com/ipfs/js-libp2p-crypto).
 
-```JavaScript
-const PeerId = window.PeerId
-```
+### `create([opts])`
 
-#### Gotchas
+Generates a new Peer ID, complete with public/private keypair.
 
-You will need to use Node.js `Buffer` API compatible, if you are running inside the browser, you can access it by `PeerId.Buffer` or you can install Feross's [Buffer](https://github.com/feross/buffer).
+- `opts: Object`: Default: `{bits: 2048}`
 
-### Creating a new 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)`
+
+Creates a Peer ID from a buffer containing a public key.
+
+### `createFromPrivKey(privKey)`
+
+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.
 
 ```
-const PeerId = require('ipfs-peer')
-
-// Create a new Id
-const id = PeerId.create()
-
-// Recreate an Id from Hex string
-const id = PeerId.createFromHexString(str)
-
-// Recreate an Id from a Buffer
-const id = PeerId.createFromBytes(buf)
-
-// Recreate an B58 String
-const id = PeerId.createFromB58String(str)
-
-// Recreate from a Public Key
-const id = PeerId.createFromPubKey(pubKey)
-
-// Recreate from a Private Key
-const id = PeerId.createFromPrivKey(privKey)
+1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
 ```
 
-### Exporting an Id
+### `toBytes()`
+
+Returns the Peer ID's `id` as a buffer.
 
 ```
-// Print friendly format
-id.toPrint() // returns an object with id, privKey and pubKey in hex format
-
-// Export to an hex string
-id.toHexString()
-
-// Export to Buffer
-id.toBytes() (same as id.id)
-
-// Export to a B58 string
-id.toB58String()
+<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>
 ```
 
-### Id format
+### `toB58String()`
+
+Returns the Peer ID's `id` as a base58 string.
 
 ```
-id.pubKey   // Buffer containing the Public Key
-id.privKey  // Buffer containing the Private Key
-id.id       // Buffer containing the multihash
+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

karma.conf.js

@@ -1,57 +0,0 @@
-module.exports = (config) => {
-  const path = require('path')
-  const node_modules_dir = path.join(__dirname, 'node_modules')
-  const deps = [
-    'deps/forge.bundle.js'
-  ]
-  config.set({
-    basePath: '',
-    frameworks: ['mocha'],
-
-    files: [
-      'tests/test.js'
-    ],
-
-    preprocessors: {
-      'tests/*': ['webpack']
-    },
-
-    webpack: {
-      resolve: {
-        extensions: ['', '.js', '.json'],
-        alias: { 'node-forge': path.resolve(__dirname, 'deps/forge.bundle.js') }
-      },
-      externals: {
-        fs: '{}'
-      },
-      node: {
-        Buffer: true
-      },
-      module: {
-        loaders: [
-          { test: /\.json$/, loader: 'json' }
-        ],
-        noParse: []
-      }
-    },
-
-    webpackMiddleware: {
-      noInfo: true,
-      stats: {
-        colors: true
-      }
-    },
-    reporters: ['spec'],
-    port: 9876,
-    colors: true,
-    logLevel: config.LOG_INFO,
-    autoWatch: false,
-    browsers: process.env.TRAVIS ? ['Firefox'] : ['Chrome'],
-    singleRun: true
-  })
-
-  deps.forEach((dep) => {
-    const depPath = path.resolve(node_modules_dir, dep)
-    config.webpack.module.noParse.push(depPath)
-  })
-}

package.json

@@ -1,14 +1,21 @@
 {
   "name": "peer-id",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "IPFS Peer Id implementation in Node.js",
-  "main": "src/index.js",
+  "main": "lib/index.js",
+  "bin": "src/bin.js",
+  "jsnext:main": "src/index.js",
   "scripts": {
-    "lint": "standard",
-    "test": "npm run test:node && npm run test:browser",
-    "test:node": "mocha tests/test.js",
-    "test:browser": "karma start karma.conf.js",
-    "coverage": "istanbul cover --print both -- _mocha tests/test.js"
+    "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"
@@ -19,12 +26,6 @@
     "lint",
     "test"
   ],
-  "standard": {
-    "ignore": [
-      "dist",
-      "deps"
-    ]
-  },
   "engines": {
     "node": "^4.3.0"
   },
@@ -33,26 +34,23 @@
   },
   "homepage": "https://github.com/diasdavid/js-peer-id",
   "devDependencies": {
-    "buffer-loader": "0.0.1",
+    "aegir": "^3.1.1",
     "chai": "^3.5.0",
-    "istanbul": "^0.4.2",
-    "json-loader": "^0.5.4",
-    "karma": "^0.13.19",
-    "karma-chrome-launcher": "^0.2.2",
-    "karma-cli": "^0.1.2",
-    "karma-firefox-launcher": "^0.1.7",
-    "karma-mocha": "^0.2.1",
-    "karma-spec-reporter": "0.0.24",
-    "karma-webpack": "^1.7.0",
-    "mocha": "^2.4.5",
-    "pre-commit": "^1.1.1",
-    "standard": "^6.0.7",
-    "webpack": "^1.12.13"
+    "pre-commit": "^1.1.3"
   },
   "dependencies": {
-    "bs58": "^3.0.0",
-    "multihashing": "^0.2.0",
-    "node-forge": "^0.6.38",
-    "protocol-buffers": "^3.1.4"
-  }
+    "libp2p-crypto": "^0.5.0",
+    "multihashes": "^0.2.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/diasdavid/js-peer-id.git"
+  },
+  "contributors": [
+    "David Dias <daviddias.p@gmail.com>",
+    "David Dias <mail@daviddias.me>",
+    "Stephen Whitmore <stephen.whitmore@gmail.com>",
+    "dignifiedquire <dignifiedquire@gmail.com>",
+    "nginnever <ginneversource@gmail.com>"
+  ]
 }

src/bin.js

@@ -0,0 +1,7 @@
+#!/usr/local/bin/node
+
+'use strict'
+
+const PeerId = require('./index.js')
+
+console.log(JSON.stringify(PeerId.create().toJSON(), null, '  '))

src/index.js

@@ -2,163 +2,151 @@
  * Id is an object representation of a peer Id. a peer Id is a multihash
  */
 
-const fs = require('fs')
-const multihashing = require('multihashing')
-const base58 = require('bs58')
-const forge = require('node-forge')
-const protobuf = require('protocol-buffers')
-const path = require('path')
+'use strict'
 
-const isNode = !global.window
+const mh = require('multihashes')
+const crypto = require('libp2p-crypto')
+const assert = require('assert')
 
-// protobuf read from file
-const messages = isNode ? protobuf(fs.readFileSync(path.resolve(__dirname, 'pb/crypto.proto')))
-                      : protobuf(require('buffer!./pb/crypto.proto'))
+class PeerId {
+  constructor (id, privKey, pubKey) {
+    assert(Buffer.isBuffer(id), 'invalid id provided')
 
-exports = module.exports = Id
-
-exports.Buffer = Buffer
-
-function Id (id, privKey, pubKey) {
-  const self = this
-
-  if (!(self instanceof Id)) {
-    throw new Error('Id must be called with new')
+    if (pubKey) {
+      assert(id.equals(pubKey.hash()), 'inconsistent arguments')
     }
 
-  self.privKey = privKey
-  self.pubKey = pubKey
-  self.id = id // multihash - sha256 - buffer
+    if (privKey) {
+      assert(id.equals(privKey.public.hash()), 'inconsistent arguments')
+    }
+
+    if (privKey && pubKey) {
+      assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
+    }
+
+    this.id = id
+    this.privKey = privKey
+    this._pubKey = pubKey
+  }
+
+  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: self.toB58String(),
-      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)
   }
 }
 
-// unwrap the private key protobuf
-function unmarshal (key) {
-  return messages.PrivateKey.decode(key)
-}
-
-// create a public key protobuf to be base64 string stored in config
-function marshal (data, type) {
-  var epb
-  if (type === 'Public') {
-    epb = messages.PublicKey.encode({
-      Type: 0,
-      Data: data
-    })
-  }
-
-  if (type === 'Private') {
-    epb = messages.PrivateKey.encode({
-      Type: 0,
-      Data: data
-    })
-  }
-
-  return epb
-}
-
-// this returns a base64 encoded protobuf of the public key
-function formatKey (key, type) {
-  // create der buffer of public key asn.1 object
-  const der = forge.asn1.toDer(key)
-
-  // create forge buffer of der public key buffer
-  const fDerBuf = forge.util.createBuffer(der.data, 'binary')
-
-  // convert forge buffer to node buffer public key
-  const nDerBuf = new Buffer(fDerBuf.getBytes(), 'binary')
-
-  // protobuf the new DER bytes to the PublicKey Data: field
-  const marshalKey = marshal(nDerBuf, type)
-
-  // encode the protobuf public key to base64 string
-  const b64 = marshalKey.toString('base64')
-  return b64
-}
+exports = module.exports = PeerId
+exports.Buffer = Buffer
 
 // generation
-exports.create = function () {
-  // generate keys
-  const pair = forge.rsa.generateKeyPair({ bits: 2048, e: 0x10001 })
+exports.create = function (opts) {
+  opts = opts || {}
+  opts.bits = opts.bits || 2048
 
-  // return the RSA public/private key to asn1 object
-  const asnPub = forge.pki.publicKeyToAsn1(pair.publicKey)
-  const asnPriv = forge.pki.privateKeyToAsn1(pair.privateKey)
+  const privKey = crypto.generateKeyPair('RSA', opts.bits)
 
-  // format the keys to protobuf base64 encoded string
-  const protoPublic64 = formatKey(asnPub, 'Public')
-  const protoPrivate64 = formatKey(asnPriv, 'Private')
-
-  const mhId = multihashing(new Buffer(protoPublic64, 'base64'), 'sha2-256')
-
-  return new Id(mhId, protoPrivate64, protoPublic64)
+  return new PeerId(privKey.public.hash(), 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) {
-  const buf = new Buffer(pubKey, 'base64')
-  const mhId = multihashing(buf, 'sha2-256')
-  return new Id(mhId, null, pubKey)
+// Public Key input will be a buffer
+exports.createFromPubKey = function (key) {
+  let buf = key
+  if (typeof buf === 'string') {
+    buf = new Buffer(key, 'base64')
+  }
+  const pubKey = crypto.unmarshalPublicKey(buf)
+  return new PeerId(pubKey.hash(), null, pubKey)
 }
 
-exports.createFromPrivKey = function (privKey) {
-  // create a buffer from the base64 encoded string
-  const buf = new Buffer(privKey, 'base64')
+// Private key input will be a string
+exports.createFromPrivKey = function (key) {
+  let buf = key
+  if (typeof buf === 'string') {
+    buf = new Buffer(key, 'base64')
+  }
 
-  // get the private key data from the protobuf
-  const mpk = unmarshal(buf)
-
-  // create a forge buffer
-  const fbuf = forge.util.createBuffer(mpk.Data.toString('binary'))
-
-  // create an asn1 object from the private key bytes saved in the protobuf Data: field
-  const asnPriv = forge.asn1.fromDer(fbuf)
-
-  // get the RSA privatekey data from the asn1 object
-  const privateKey = forge.pki.privateKeyFromAsn1(asnPriv)
-
-  // set the RSA public key to the modulus and exponent of the private key
-  const publicKey = forge.pki.rsa.setPublicKey(privateKey.n, privateKey.e)
-
-  // return the RSA public key to asn1 object
-  const asnPub = forge.pki.publicKeyToAsn1(publicKey)
-
-  // format the public key
-  const protoPublic64 = formatKey(asnPub, 'Public')
-  const mhId = multihashing(new Buffer(protoPublic64, 'base64'), 'sha2-256')
-  return new Id(mhId, privKey, protoPublic64)
+  const privKey = crypto.unmarshalPrivateKey(buf)
+  return new PeerId(privKey.public.hash(), privKey)
+}
+
+exports.createFromJSON = function (obj) {
+  let priv
+  let pub
+
+  if (obj.privKey) {
+    priv = crypto.unmarshalPrivateKey(new Buffer(obj.privKey, 'base64'))
+  }
+
+  if (obj.pubKey) {
+    pub = crypto.unmarshalPublicKey(new Buffer(obj.pubKey, 'base64'))
+  }
+
+  return new PeerId(mh.fromB58String(obj.id), priv, pub)
+}
+
+function toB64Opt (val) {
+  if (val) {
+    return val.toString('base64')
+  }
 }

src/pb/crypto.proto

@@ -1,13 +0,0 @@
-enum KeyType {
-	RSA = 0;
-}
-
-message PublicKey {
-	required KeyType Type = 1;
-	required bytes Data = 2;
-}
-
-message PrivateKey {
-	required KeyType Type = 1;
-	required bytes Data = 2;
-}

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

@@ -1,59 +1,7 @@
-/* globals describe, it */
-
 'use strict'
 
-const expect = require('chai').expect
-const PeerId = require('../src')
-
-const testId = {
-  id: '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d',
+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='
 }
-
-const testIdHex = '1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d'
-
-const testIdBytes = new Buffer('1220151ab1658d8294ab34b71d5582cfe20d06414212f440a69366f1bc31deb5c72d', 'hex')
-
-const testIdB58String = 'QmQ2zigjQikYnyYUSXZydNXrDRhBut2mubwJBaLXobMt3A'
-
-describe('id', function (done) {
-  this.timeout(30000)
-
-  it('create a new id', (done) => {
-    const id = PeerId.create()
-    expect(id.toB58String().length).to.equal(46)
-    done()
-  })
-
-  it('recreate an Id from Hex string', (done) => {
-    const id = PeerId.createFromHexString(testIdHex)
-    expect(testIdBytes).to.deep.equal(id.id)
-    done()
-  })
-
-  it('Recreate an Id from a Buffer', (done) => {
-    const id = PeerId.createFromBytes(testIdBytes)
-    expect(testId.id).to.equal(id.toHexString())
-    done()
-  })
-
-  it('Recreate a B58 String', (done) => {
-    const id = PeerId.createFromB58String(testIdB58String)
-    expect(testIdB58String).to.equal(id.toB58String())
-    done()
-  })
-
-  it('Recreate from a Public Key', (done) => {
-    const id = PeerId.createFromPubKey(testId.pubKey)
-    expect(testIdB58String).to.equal(id.toB58String())
-    done()
-  })
-
-  it('Recreate from a Private Key', (done) => {
-    const id = PeerId.createFromPrivKey(testId.privKey)
-    expect(testIdB58String).to.equal(id.toB58String())
-    done()
-  })
-})
-

test/index.spec.js

@@ -0,0 +1,170 @@
+/* eslint-env mocha */
+'use strict'
+
+const expect = require('chai').expect
+const crypto = require('libp2p-crypto')
+const mh = require('multihashes')
+
+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', () => {
+    const id = PeerId.create()
+    expect(id.toB58String().length).to.equal(46)
+  })
+
+  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', () => {
+    const id = PeerId.createFromPubKey(testId.pubKey)
+    expect(testIdB58String).to.equal(id.toB58String())
+  })
+
+  it('Recreate from a Private Key', () => {
+    const id = PeerId.createFromPrivKey(testId.privKey)
+    expect(testIdB58String).to.equal(id.toB58String())
+
+    const id2 = PeerId.createFromPrivKey(new Buffer(testId.privKey, 'base64'))
+    expect(testIdB58String).to.equal(id2.toB58String())
+  })
+
+  it('Compare generated ID with one created from PubKey', () => {
+    const id1 = PeerId.create()
+    const id2 = PeerId.createFromPubKey(id1.marshalPubKey())
+    expect(id1.id).to.be.eql(id2.id)
+  })
+
+  it('Non-default # of bits', () => {
+    const shortId = PeerId.create({ bits: 128 })
+    const longId = PeerId.create({ bits: 256 })
+    expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
+  })
+
+  it('Pretty printing', () => {
+    const id = PeerId.createFromPrivKey(testId.privKey)
+    const out = id.toPrint()
+
+    expect(out.id).to.equal(testIdB58String)
+    expect(out.privKey).to.equal(testId.privKey)
+    expect(out.pubKey).to.equal(testId.pubKey)
+  })
+
+  it('toBytes', () => {
+    const id = PeerId.createFromHexString(testIdHex)
+    expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
+  })
+
+  describe('toJSON', () => {
+    it('full node', () => {
+      const id = PeerId.create({bits: 64})
+      expect(
+        id.toB58String()
+      ).to.equal(
+        PeerId.createFromJSON(id.toJSON()).toB58String()
+      )
+      expect(
+        id.privKey.bytes
+      ).to.deep.equal(
+        PeerId.createFromJSON(id.toJSON()).privKey.bytes
+      )
+      expect(
+        id.pubKey.bytes
+      ).to.deep.equal(
+        PeerId.createFromJSON(id.toJSON()).pubKey.bytes
+      )
+    })
+
+    it('only id', () => {
+      const key = crypto.generateKeyPair('RSA', 64)
+      const id = PeerId.createFromBytes(key.public.hash())
+      expect(
+        id.toB58String()
+      ).to.equal(
+        PeerId.createFromJSON(id.toJSON()).toB58String()
+      )
+
+      expect(id.privKey).to.not.exist
+      expect(id.pubKey).to.not.exist
+    })
+
+    it('go interop', () => {
+      const id = PeerId.createFromJSON(goId)
+
+      expect(
+        mh.toB58String(id.privKey.public.hash())
+      ).to.be.eql(
+        goId.id
+      )
+    })
+  })
+
+  describe('throws on inconsistent data', () => {
+    const k1 = crypto.generateKeyPair('RSA', 64)
+    const k2 = crypto.generateKeyPair('RSA', 64)
+    const k3 = crypto.generateKeyPair('RSA', 64)
+
+    it('missmatch id - private key', () => {
+      expect(
+        () => new PeerId(k1.public.hash(), k2)
+      ).to.throw(
+        /inconsistent arguments/
+      )
+    })
+
+    it('missmatch id - public key', () => {
+      expect(
+        () => new PeerId(k1.public.hash(), null, k2.public)
+      ).to.throw(
+        /inconsistent arguments/
+      )
+    })
+
+    it('missmatch private - public key', () => {
+      expect(
+        () => new PeerId(k1.public.hash(), k1, k2.public)
+      ).to.throw(
+        /inconsistent arguments/
+      )
+    })
+
+    it('missmatch id - private - public key', () => {
+      expect(
+        () => new PeerId(k1.public.hash(), k1, k3.public)
+      ).to.throw(
+        /inconsistent arguments/
+      )
+    })
+
+    it('invalid id', () => {
+      expect(
+        () => new PeerId(k1.public.hash().toString())
+      ).to.throw(
+        /invalid id/
+      )
+    })
+  })
+})