chore: release version v0.13.12

Bumps [cids](https://github.com/multiformats/js-cid) from 0.7.5 to 0.8.0.
- [Release notes](https://github.com/multiformats/js-cid/releases)
- [Changelog](https://github.com/multiformats/js-cid/blob/master/CHANGELOG.md)
- [Commits](https://github.com/multiformats/js-cid/compare/v0.7.5...v0.8.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -1,3 +1,48 @@
+<a name="0.13.12"></a>
+## [0.13.12](https://github.com/libp2p/js-peer-id/compare/v0.13.11...v0.13.12) (2020-04-22)
+
+
+### Features
+
+* **cli:** add support for specifying type and size ([#122](https://github.com/libp2p/js-peer-id/issues/122)) ([8cd9dfb](https://github.com/libp2p/js-peer-id/commit/8cd9dfb))
+
+
+
+<a name="0.13.11"></a>
+## [0.13.11](https://github.com/libp2p/js-peer-id/compare/v0.13.10...v0.13.11) (2020-03-26)
+
+
+
+<a name="0.13.10"></a>
+## [0.13.10](https://github.com/libp2p/js-peer-id/compare/v0.13.9...v0.13.10) (2020-03-18)
+
+
+### Bug Fixes
+
+* add buffer ([#120](https://github.com/libp2p/js-peer-id/issues/120)) ([c305c36](https://github.com/libp2p/js-peer-id/commit/c305c36))
+
+
+
+<a name="0.13.9"></a>
+## [0.13.9](https://github.com/libp2p/js-peer-id/compare/v0.13.8...v0.13.9) (2020-02-19)
+
+
+
+<a name="0.13.8"></a>
+## [0.13.8](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.8) (2020-02-18)
+
+
+### Bug Fixes
+
+* remove use of assert module ([#117](https://github.com/libp2p/js-peer-id/issues/117)) ([f44645e](https://github.com/libp2p/js-peer-id/commit/f44645e))
+
+
+### Features
+
+* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae))
+
+
+
 <a name="0.13.7"></a>
 ## [0.13.7](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.7) (2020-01-27)
 

README.md

@@ -28,6 +28,7 @@
   - [Node.js](#nodejs)
   - [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
   - [Browser: `<script>` Tag](#browser-script-tag)
+- [CLI](#cli)
 - [API](#api)
   - [Create](#create)
     - [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
@@ -117,6 +118,14 @@ the global namespace.
 <script src="https://unpkg.com/peer-id/dist/index.js"></script>
 ```
 
+# CLI
+
+After installing `peer-id`, `npm install peer-id`, you can leverage the cli to generate keys exported as JSON. You can specify the type for the key and size, as detailed in [`create([opts])`](#createopts). The defaults are shown here.
+
+```sh
+> peer-id --type rsa --bits 2048
+```
+
 # API
 
 ```js
@@ -137,7 +146,8 @@ The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2
 
 Generates a new Peer ID, complete with public/private keypair.
 
-- `opts: Object`: Default: `{bits: 2048, keyType: 'rsa'}`
+- `opts.bits: number` - The size of the key. Default: `2048`
+- `opts.keyType: string` - The key type, one of: `['rsa', 'ed25519', 'secp256k1']`. Default: `rsa`
 
 Returns `Promise<PeerId>`.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "peer-id",
-  "version": "0.13.7",
+  "version": "0.13.12",
   "description": "IPFS Peer Id implementation in Node.js",
   "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
   "main": "src/index.js",
@@ -38,49 +38,49 @@
   "devDependencies": {
     "@types/chai": "^4.2.7",
     "@types/dirty-chai": "^2.0.2",
-    "@types/mocha": "^5.2.7",
-    "aegir": "^20.0.0",
+    "@types/mocha": "^7.0.2",
+    "aegir": "^21.2.0",
     "bundlesize": "~0.18.0",
     "chai": "^4.2.0",
     "dirty-chai": "^2.0.1"
   },
   "dependencies": {
-    "cids": "^0.7.3",
+    "buffer": "^5.5.0",
+    "cids": "^0.8.0",
     "class-is": "^1.1.0",
-    "libp2p-crypto": "~0.17.2",
+    "libp2p-crypto": "~0.17.3",
+    "minimist": "^1.2.5",
     "multihashes": "~0.4.15",
-    "protons": "^1.0.1"
+    "protons": "^1.0.2"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/libp2p/js-peer-id.git"
   },
   "contributors": [
+    "David Dias <daviddias.p@gmail.com>",
+    "Vasco Santos <vasco.santos@moxy.studio>",
+    "nginnever <ginneversource@gmail.com>",
+    "dignifiedquire <dignifiedquire@gmail.com>",
+    "Jacob Heun <jacobheun@gmail.com>",
+    "Pedro Teixeira <i@pgte.me>",
+    "Stephen Whitmore <stephen.whitmore@gmail.com>",
+    "Maciej Krüger <mkg20001@gmail.com>",
+    "Hugo Dias <hugomrdias@gmail.com>",
+    "Nate Foss <npfoss@gmail.com>",
+    "Robert Kiel <robert.kiel@validitylabs.org>",
+    "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
     "Arve Knudsen <arve.knudsen@gmail.com>",
     "Carson Farmer <carson.farmer@gmail.com>",
     "Christian Paul <info@jaller.de>",
-    "David Dias <daviddias.p@gmail.com>",
-    "David Dias <mail@daviddias.me>",
-    "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
     "Henrique Dias <hacdias@gmail.com>",
-    "Hugo Dias <hugomrdias@gmail.com>",
-    "Jacob Heun <jacobheun@gmail.com>",
-    "Maciej Krüger <mkg20001@gmail.com>",
     "Marcin Rataj <lidel@lidel.org>",
     "Michael Garvin <gar+gh@danger.computer>",
-    "Nate Foss <npfoss@gmail.com>",
-    "Pedro Teixeira <i@pgte.me>",
     "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "Richard Schneider <makaretu@gmail.com>",
-    "Stephen Whitmore <stephen.whitmore@gmail.com>",
     "Topper Bowers <topper@quorumcontrol.com>",
-    "Vasco Santos <vasco.santos@moxy.studio>",
-    "Vasco Santos <vasco.santos@ua.pt>",
     "Yahya <ya7yaz@gmail.com>",
-    "greenkeeperio-bot <support@greenkeeper.io>",
-    "nginnever <ginneversource@gmail.com>",
-    "npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>",
-    "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
+    "Alex Potsides <alex@achingbrain.net>"
   ]
 }

src/bin.js

@@ -3,9 +3,13 @@
 'use strict'
 
 const PeerId = require('./index.js')
+const argv = require('minimist')(process.argv.slice(2))
 
 async function main () {
-  const id = await PeerId.create()
+  const id = await PeerId.create({
+    keyType: argv.type,
+    bits: argv.bits
+  })
   console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console
 }
 

src/index.d.ts

@@ -38,7 +38,7 @@ declare namespace PeerId {
    * Checks if a value is an instance of PeerId.
    * @param id The value to check.
    */
-  function isPeerId(id: any): boolean
+  function isPeerId(id: any): id is PeerId
 
   /**
    * Create a new PeerId.
@@ -105,7 +105,7 @@ declare class PeerId {
   /**
    * Raw id.
    */
-  id: Buffer;
+  readonly id: Buffer;
 
   /**
    * Private key.

src/index.js

@@ -4,19 +4,21 @@
 
 'use strict'
 
+const { Buffer } = require('buffer')
 const mh = require('multihashes')
 const CID = require('cids')
 const cryptoKeys = require('libp2p-crypto/src/keys')
-const assert = require('assert')
 const withIs = require('class-is')
 const { PeerIdProto } = require('./proto')
 
 class PeerId {
   constructor (id, privKey, pubKey) {
-    assert(Buffer.isBuffer(id), 'invalid id provided')
+    if (!Buffer.isBuffer(id)) {
+      throw new Error('invalid id provided')
+    }
 
-    if (privKey && pubKey) {
-      assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
+    if (privKey && pubKey && !privKey.public.bytes.equals(pubKey.bytes)) {
+      throw new Error('inconsistent arguments')
     }
 
     this._id = id

test/peer-id.spec.js

@@ -2,6 +2,7 @@
 /* eslint-env mocha */
 'use strict'
 
+const { Buffer } = require('buffer')
 const chai = require('chai')
 const dirtyChai = require('dirty-chai')
 chai.use(dirtyChai)
@@ -62,6 +63,7 @@ describe('PeerId', () => {
     const id = await PeerId.create(testOpts)
     expect(id.toB58String().length).to.equal(46)
     expect(() => {
+      // @ts-ignore
       id.id = Buffer.from('hello')
     }).to.throw(/immutable/)
   })