bump dependencies

Makes the cached string cid property non-enumerable so deep equals
still works even after a peer id has been stringifed.

Fixes #141

.aegir.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = {
+  bundlesize: {
+    maxSize: '140kB'
+  }
+}

CHANGELOG.md

@@ -1,3 +1,127 @@
+## [0.14.6](https://github.com/libp2p/js-peer-id/compare/v0.14.4...v0.14.6) (2021-04-06)
+
+
+
+## [0.14.4](https://github.com/libp2p/js-peer-id/compare/v0.14.3...v0.14.4) (2021-03-29)
+
+
+### Bug Fixes
+
+* remove toString side effect that breaks deep equals ([#142](https://github.com/libp2p/js-peer-id/issues/142)) ([eeb5330](https://github.com/libp2p/js-peer-id/commit/eeb53305c8767a6a2b3f610fe9e45a589b4fa972)), closes [#141](https://github.com/libp2p/js-peer-id/issues/141)
+
+
+
+## [0.14.3](https://github.com/libp2p/js-peer-id/compare/v0.14.2...v0.14.3) (2021-01-26)
+
+
+
+<a name="0.14.2"></a>
+## [0.14.2](https://github.com/libp2p/js-peer-id/compare/v0.14.1...v0.14.2) (2020-09-23)
+
+
+### Features
+
+* has inline public key method ([#132](https://github.com/libp2p/js-peer-id/issues/132)) ([b2ee342](https://github.com/libp2p/js-peer-id/commit/b2ee342))
+
+
+
+<a name="0.14.1"></a>
+## [0.14.1](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.1) (2020-09-03)
+
+
+### Bug Fixes
+
+* privKey possible undefined ([#129](https://github.com/libp2p/js-peer-id/issues/129)) ([224b30c](https://github.com/libp2p/js-peer-id/commit/224b30c))
+* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
+* ts constructor types ([#130](https://github.com/libp2p/js-peer-id/issues/130)) ([d40d588](https://github.com/libp2p/js-peer-id/commit/d40d588))
+* typo in readme ([#128](https://github.com/libp2p/js-peer-id/issues/128)) ([6d571ae](https://github.com/libp2p/js-peer-id/commit/6d571ae))
+
+
+### BREAKING CHANGES
+
+* - Where node Buffers were returned, now Uint8Arrays are
+
+* chore: remove gh dep
+
+
+
+<a name="0.14.0"></a>
+# [0.14.0](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.0) (2020-08-07)
+
+
+### Bug Fixes
+
+* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
+
+
+### BREAKING CHANGES
+
+* - Where node Buffers were returned, now Uint8Arrays are
+
+* chore: remove gh dep
+
+
+
+<a name="0.13.13"></a>
+## [0.13.13](https://github.com/libp2p/js-peer-id/compare/v0.13.12...v0.13.13) (2020-06-23)
+
+
+
+<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)
+
+
+### Features
+
+* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae))
+
+
+
 <a name="0.13.6"></a>
 ## [0.13.6](https://github.com/libp2p/js-peer-id/compare/v0.13.5...v0.13.6) (2019-12-18)
 

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)
@@ -52,6 +53,8 @@
     - [`toPrint()`](#toprint)
     - [`equals(id)`](#equalsid)
     - [`isEqual(id)`](#isequalid)
+  - [Others](#others)
+    - [`isPeerId(id)`](#ispeeridid)
 - [License](#license)
 
 # Description
@@ -67,7 +70,7 @@ The public key is a base64 encoded string of a protobuf containing an RSA DER bu
 ```JavaScript
 const PeerId = require('peer-id')
 
-const id = await PeerId.create({ bits: 1024, keyType: 'rsa' })
+const id = await PeerId.create({ bits: 1024, keyType: 'RSA' })
 console.log(JSON.stringify(id.toJSON(), null, 2))
 ```
 
@@ -117,6 +120,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 +148,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>`.
 
@@ -147,7 +159,7 @@ Returns `Promise<PeerId>`.
 
 Creates a Peer ID from hex string representing the key's multihash.
 
-Returns `PeerId.
+Returns `PeerId`.
 
 ### `createFromBytes(buf)`
 
@@ -275,6 +287,14 @@ Returns `true` if the given PeerId is equal to the current instance.
 
 - `id` can be a PeerId or a Buffer containing the id
 
+## Others
+
+### `isPeerId(id)`
+
+Returns `true` if the given id is an instance of PeerId
+
+- `id` should be an instance of PeerId
+
 # License
 
 MIT

package.json

@@ -1,21 +1,23 @@
 {
   "name": "peer-id",
-  "version": "0.13.6",
+  "version": "0.14.6",
   "description": "IPFS Peer Id implementation in Node.js",
   "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "bin": "src/bin.js",
   "scripts": {
     "lint": "aegir lint",
-    "build": "aegir build",
+    "build": "aegir build --no-types",
     "test": "aegir test",
     "test:node": "aegir test -t node",
     "test:browser": "aegir test -t browser -t webworker",
-    "release": "aegir release",
+    "test:types": "npx tsc",
+    "release": "aegir release --no-types",
     "release-minor": "aegir release --type minor",
     "release-major": "aegir release --type major",
     "coverage": "aegir coverage",
-    "size": "bundlesize -f dist/index.min.js -s 140kB"
+    "size": "aegir build -b"
   },
   "files": [
     "src",
@@ -34,47 +36,51 @@
   },
   "homepage": "https://github.com/libp2p/js-peer-id",
   "devDependencies": {
-    "aegir": "^20.0.0",
-    "bundlesize": "~0.18.0",
-    "chai": "^4.2.0",
-    "dirty-chai": "^2.0.1"
+    "@types/chai": "^4.2.14",
+    "@types/dirty-chai": "^2.0.2",
+    "@types/mocha": "^8.2.0",
+    "aegir": "^32.2.0"
   },
   "dependencies": {
-    "cids": "~0.7.1",
+    "cids": "^1.1.6",
     "class-is": "^1.1.0",
-    "libp2p-crypto": "~0.17.0",
-    "multihashes": "~0.4.15",
-    "protons": "^1.0.1"
+    "libp2p-crypto": "fluencelabs/js-libp2p-crypto",
+    "minimist": "^1.2.5",
+    "multihashes": "^4.0.2",
+    "protons": "^2.0.0",
+    "uint8arrays": "^2.1.4"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/libp2p/js-peer-id.git"
   },
   "contributors": [
-    "Arve Knudsen <arve.knudsen@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>",
+    "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>",
+    "Alex Potsides <alex@achingbrain.net>",
+    "Hugo Dias <hugomrdias@gmail.com>",
     "Maciej Krüger <mkg20001@gmail.com>",
+    "Nate Foss <npfoss@gmail.com>",
+    "Robert Kiel <robert.kiel@validitylabs.org>",
+    "Adam Uhlíř <adam@uhlir.dev>",
+    "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
+    "Arve Knudsen <arve.knudsen@gmail.com>",
+    "Carson Farmer <carson.farmer@gmail.com>",
+    "Christian Paul <info@jaller.de>",
+    "Henrique Dias <hacdias@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>",
+    "Vojtech Simetka <vojtech@simetka.cz>",
     "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>"
+    "a1300 <matthias-knopp@gmx.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

@@ -0,0 +1,193 @@
+import { PrivateKey, PublicKey, KeyType } from "libp2p-crypto";
+import CID from 'cids'
+
+declare namespace PeerId {
+  /**
+   * Options for PeerId creation.
+   */
+  type CreateOptions = {
+    /**
+     * The number of bits to use.
+     */
+    bits?: number;
+    /**
+     * The type of key to use.
+     */
+    keyType?: KeyType;
+  };
+
+  /**
+   * PeerId JSON format.
+   */
+  type JSONPeerId = {
+    /**
+     * String representation of PeerId.
+     */
+    id: string;
+    /**
+     * Public key.
+     */
+    pubKey?: string;
+    /**
+     * Private key.
+     */
+    privKey?: string;
+  };
+
+  /**
+   * Checks if a value is an instance of PeerId.
+   * @param id The value to check.
+   */
+  function isPeerId(id: any): id is PeerId
+
+  /**
+   * Create a new PeerId.
+   * @param opts Options.
+   */
+  function create(opts?: PeerId.CreateOptions): Promise<PeerId>;
+
+  /**
+   * Create PeerId from hex string.
+   * @param str The input hex string.
+   */
+  function createFromHexString(str: string): PeerId;
+
+  /**
+   * Create PeerId from raw bytes.
+   * @param buf The raw bytes.
+   */
+  function createFromBytes(buf: Uint8Array): PeerId;
+
+  /**
+   * Create PeerId from base58-encoded string.
+   * @param str The base58-encoded string.
+   */
+  function createFromB58String(str: string): PeerId;
+
+  /**
+   * Create PeerId from CID.
+   * @param cid The CID.
+   */
+  function createFromCID(cid: CID | Uint8Array | string | object): PeerId;
+
+  /**
+   * Create PeerId from public key.
+   * @param key Public key, as Uint8Array or base64-encoded string.
+   */
+  function createFromPubKey(key: Uint8Array | string): Promise<PeerId>;
+
+  /**
+   * Create PeerId from private key.
+   * @param key Private key, as Uint8Array or base64-encoded string.
+   */
+  function createFromPrivKey(key: Uint8Array | string): Promise<PeerId>;
+
+  /**
+   * Create PeerId from PeerId JSON formatted object.
+   * @see {@link PeerId#toJSON}
+   * @param json PeerId in JSON format.
+   */
+  function createFromJSON(json: JSONPeerId): Promise<PeerId>;
+
+  /**
+   * Create PeerId from Protobuf bytes.
+   * @param buf Protobuf bytes, as Uint8Array or hex-encoded string.
+   */
+  function createFromProtobuf(buf: Uint8Array | string): Promise<PeerId>;
+}
+
+/**
+ * PeerId is an object representation of a peer identifier.
+ */
+declare class PeerId {
+  constructor(id: Uint8Array, privKey?: PrivateKey, pubKey?: PublicKey);
+
+  /**
+   * Raw id.
+   */
+  readonly id: Uint8Array;
+
+  /**
+   * Private key.
+   */
+  privKey: PrivateKey;
+
+  /**
+   * Public key.
+   */
+  pubKey: PublicKey;
+
+  /**
+   * Return the protobuf version of the public key, matching go ipfs formatting.
+   */
+  marshalPubKey(): Uint8Array;
+
+  /**
+   * Return the protobuf version of the private key, matching go ipfs formatting.
+   */
+  marshalPrivKey(): Uint8Array;
+
+  /**
+   * Return the protobuf version of the peer-id.
+   * @param excludePriv Whether to exclude the private key information from the output.
+   */
+  marshal(excludePriv?: boolean): Uint8Array;
+
+  /**
+   * String representation.
+   */
+  toPrint(): string;
+
+  /**
+   * Return the jsonified version of the key.
+   * Matches the formatting of go-ipfs for its config file.
+   * @see {@link PeerId.createFromJSON}
+   */
+  toJSON(): PeerId.JSONPeerId;
+
+  /**
+   * Encode to hex.
+   */
+  toHexString(): string;
+
+  /**
+   * Return raw id bytes.
+   */
+  toBytes(): Uint8Array;
+
+  /**
+   * Encode to base58 string.
+   */
+  toB58String(): string;
+
+  /**
+   * Return self-describing string representation.
+   * Uses default format from RFC 0001: https://github.com/libp2p/specs/pull/209
+   */
+  toString(): string;
+
+  /**
+   * Checks the equality of `this` peer against a given PeerId.
+   * @param id The other PeerId.
+   */
+  equals(id: PeerId | Uint8Array): boolean;
+
+  /**
+   * Checks the equality of `this` peer against a given PeerId.
+   * @deprecated Use {.equals}
+   * @param id The other PeerId.
+   */
+  isEqual(id: PeerId | Uint8Array): boolean;
+
+  /**
+   * Check if this PeerId instance is valid (privKey -> pubKey -> Id)
+   */
+  isValid(): boolean;
+
+  /**
+   * Check if the PeerId has an inline public key.
+   */
+  hasInlinePublicKey(): boolean;
+}
+
+export = PeerId;

src/index.js

@@ -7,16 +7,20 @@
 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')
+const uint8ArrayEquals = require('uint8arrays/equals')
+const uint8ArrayFromString = require('uint8arrays/from-string')
+const uint8ArrayToString = require('uint8arrays/to-string')
 
 class PeerId {
   constructor (id, privKey, pubKey) {
-    assert(Buffer.isBuffer(id), 'invalid id provided')
+    if (!(id instanceof Uint8Array)) {
+      throw new Error('invalid id provided')
+    }
 
-    if (privKey && pubKey) {
-      assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
+    if (privKey && pubKey && !uint8ArrayEquals(privKey.public.bytes, pubKey.bytes)) {
+      throw new Error('inconsistent arguments')
     }
 
     this._id = id
@@ -133,21 +137,26 @@ class PeerId {
   toString () {
     if (!this._idCIDString) {
       const cid = new CID(1, 'libp2p-key', this.id, 'base32')
-      this._idCIDString = cid.toBaseEncodedString('base32')
+
+      Object.defineProperty(this, '_idCIDString', {
+        value: cid.toBaseEncodedString('base32'),
+        enumerable: false
+      })
     }
     return this._idCIDString
   }
 
   /**
    * Checks the equality of `this` peer against a given PeerId.
-   * @param {Buffer|PeerId} id
+   *
+   * @param {Uint8Array|PeerId} id
    * @returns {boolean}
    */
   equals (id) {
-    if (Buffer.isBuffer(id)) {
-      return this.id.equals(id)
+    if (id instanceof Uint8Array) {
+      return uint8ArrayEquals(this.id, id)
     } else if (id.id) {
-      return this.id.equals(id.id)
+      return uint8ArrayEquals(this.id, id.id)
     } else {
       throw new Error('not valid Id')
     }
@@ -155,8 +164,9 @@ class PeerId {
 
   /**
    * Checks the equality of `this` peer against a given PeerId.
+   *
    * @deprecated Use `.equals`
-   * @param {Buffer|PeerId} id
+   * @param {Uint8Array|PeerId} id
    * @returns {boolean}
    */
   isEqual (id) {
@@ -171,8 +181,26 @@ class PeerId {
     return Boolean(this.privKey &&
       this.privKey.public &&
       this.privKey.public.bytes &&
-      Buffer.isBuffer(this.pubKey.bytes) &&
-      this.privKey.public.bytes.equals(this.pubKey.bytes))
+      this.pubKey.bytes instanceof Uint8Array &&
+        uint8ArrayEquals(this.privKey.public.bytes, this.pubKey.bytes))
+  }
+
+  /**
+   * Check if the PeerId has an inline public key.
+   *
+   * @returns {boolean}
+   */
+  hasInlinePublicKey () {
+    try {
+      const decoded = mh.decode(this.id)
+      if (decoded.name === 'identity') {
+        return true
+      }
+    } catch (_) {
+      // Ignore, there is no valid public key
+    }
+
+    return false
   }
 }
 
@@ -229,16 +257,16 @@ exports.createFromCID = (cid) => {
   return new PeerIdWithIs(cid.multihash)
 }
 
-// Public Key input will be a buffer
+// Public Key input will be a Uint8Array
 exports.createFromPubKey = async (key) => {
   let buf = key
 
   if (typeof buf === 'string') {
-    buf = Buffer.from(key, 'base64')
+    buf = uint8ArrayFromString(key, 'base64pad')
   }
 
-  if (!Buffer.isBuffer(buf)) {
-    throw new Error('Supplied key is neither a base64 string nor a buffer')
+  if (!(buf instanceof Uint8Array)) {
+    throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
   }
 
   const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
@@ -247,24 +275,22 @@ exports.createFromPubKey = async (key) => {
 
 // Private key input will be a string
 exports.createFromPrivKey = async (key) => {
-  let buf = key
-
-  if (typeof buf === 'string') {
-    buf = Buffer.from(key, 'base64')
+  if (typeof key === 'string') {
+    key = uint8ArrayFromString(key, 'base64pad')
   }
 
-  if (!Buffer.isBuffer(buf)) {
-    throw new Error('Supplied key is neither a base64 string nor a buffer')
+  if (!(key instanceof Uint8Array)) {
+    throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
   }
 
-  const privKey = await cryptoKeys.unmarshalPrivateKey(buf)
+  const privKey = await cryptoKeys.unmarshalPrivateKey(key)
   return computePeerId(privKey, privKey.public)
 }
 
 exports.createFromJSON = async (obj) => {
   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 rawPrivKey = obj.privKey && uint8ArrayFromString(obj.privKey, 'base64pad')
+  const rawPubKey = obj.pubKey && uint8ArrayFromString(obj.pubKey, 'base64pad')
   const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
 
   if (!rawPrivKey) {
@@ -280,11 +306,11 @@ exports.createFromJSON = async (obj) => {
     pubDigest = await computeDigest(pub)
   }
 
-  if (pub && !privDigest.equals(pubDigest)) {
+  if (pub && !uint8ArrayEquals(privDigest, pubDigest)) {
     throw new Error('Public and private key do not match')
   }
 
-  if (id && !privDigest.equals(id)) {
+  if (id && !uint8ArrayEquals(privDigest, id)) {
     throw new Error('Id and private key do not match')
   }
 
@@ -293,7 +319,7 @@ exports.createFromJSON = async (obj) => {
 
 exports.createFromProtobuf = async (buf) => {
   if (typeof buf === 'string') {
-    buf = Buffer.from(buf, 'hex')
+    buf = uint8ArrayFromString(buf, 'base16')
   }
 
   let { id, privKey, pubKey } = PeerIdProto.decode(buf)
@@ -314,7 +340,7 @@ exports.createFromProtobuf = async (buf) => {
 
   if (privKey) {
     if (pubKey) {
-      if (!privDigest.equals(pubDigest)) {
+      if (!uint8ArrayEquals(privDigest, pubDigest)) {
         throw new Error('Public and private key do not match')
       }
     }
@@ -342,6 +368,6 @@ exports.isPeerId = (peerId) => {
 
 function toB64Opt (val) {
   if (val) {
-    return val.toString('base64')
+    return uint8ArrayToString(val, 'base64pad')
   }
 }

test/peer-id.spec.js

@@ -2,13 +2,12 @@
 /* eslint-env mocha */
 'use strict'
 
-const chai = require('chai')
-const dirtyChai = require('dirty-chai')
-chai.use(dirtyChai)
-const expect = chai.expect
+const { expect } = require('aegir/utils/chai')
 const crypto = require('libp2p-crypto')
 const mh = require('multihashes')
 const CID = require('cids')
+const uint8ArrayFromString = require('uint8arrays/from-string')
+const uint8ArrayToString = require('uint8arrays/to-string')
 
 const PeerId = require('../src')
 
@@ -55,14 +54,15 @@ describe('PeerId', () => {
     const id = await PeerId.create(testOpts)
     expect(PeerId.isPeerId(id)).to.equal(true)
     expect(PeerId.isPeerId('aaa')).to.equal(false)
-    expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
+    expect(PeerId.isPeerId(uint8ArrayFromString('batatas'))).to.equal(false)
   })
 
   it('throws on changing the id', async () => {
     const id = await PeerId.create(testOpts)
     expect(id.toB58String().length).to.equal(46)
     expect(() => {
-      id.id = Buffer.from('hello')
+      // @ts-ignore
+      id.id = uint8ArrayFromString('hello')
     }).to.throw(/immutable/)
   })
 
@@ -71,7 +71,7 @@ describe('PeerId', () => {
     expect(testIdBytes).to.deep.equal(id.toBytes())
   })
 
-  it('recreate from a Buffer', () => {
+  it('recreate from a Uint8Array', () => {
     const id = PeerId.createFromBytes(testIdBytes)
     expect(testId.id).to.equal(id.toHexString())
     expect(testIdBytes).to.deep.equal(id.toBytes())
@@ -112,8 +112,8 @@ describe('PeerId', () => {
     expect(testIdBytes).to.deep.equal(id.toBytes())
   })
 
-  it('recreate from CID Buffer', () => {
-    const id = PeerId.createFromCID(testIdCID.buffer)
+  it('recreate from CID Uint8Array', () => {
+    const id = PeerId.createFromCID(testIdCID.bytes)
     expect(testIdCIDString).to.equal(id.toString())
     expect(testIdBytes).to.deep.equal(id.toBytes())
   })
@@ -158,7 +158,7 @@ describe('PeerId', () => {
   it('recreate from a Private Key', async () => {
     const id = await PeerId.createFromPrivKey(testId.privKey)
     expect(testIdB58String).to.equal(id.toB58String())
-    const encoded = Buffer.from(testId.privKey, 'base64')
+    const encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
     const id2 = await PeerId.createFromPrivKey(encoded)
     expect(testIdB58String).to.equal(id2.toB58String())
     expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
@@ -167,11 +167,11 @@ describe('PeerId', () => {
   it('recreate from Protobuf', async () => {
     const id = await PeerId.createFromProtobuf(testId.marshaled)
     expect(testIdB58String).to.equal(id.toB58String())
-    const encoded = Buffer.from(testId.privKey, 'base64')
+    const encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
     const id2 = await PeerId.createFromPrivKey(encoded)
     expect(testIdB58String).to.equal(id2.toB58String())
     expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
-    expect(id.marshal().toString('hex')).to.deep.equal(testId.marshaled)
+    expect(uint8ArrayToString(id.marshal(), 'base16')).to.deep.equal(testId.marshaled)
   })
 
   it('can be created from a Secp256k1 public key', async () => {
@@ -216,7 +216,7 @@ describe('PeerId', () => {
 
   it('toBytes', () => {
     const id = PeerId.createFromHexString(testIdHex)
-    expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
+    expect(uint8ArrayToString(id.toBytes(), 'base16')).to.equal(uint8ArrayToString(testIdBytes, 'base16'))
   })
 
   it('isEqual', async () => {
@@ -243,6 +243,18 @@ describe('PeerId', () => {
     expect(ids[0].equals(ids[1].id)).to.equal(false)
   })
 
+  describe('hasInlinePublicKey', () => {
+    it('returns true if uses a key type with inline public key', async () => {
+      const peerId = await PeerId.create({ keyType: 'secp256k1' })
+      expect(peerId.hasInlinePublicKey()).to.equal(true)
+    })
+
+    it('returns false if uses a key type with no inline public key', async () => {
+      const peerId = await PeerId.create({ keyType: 'RSA' })
+      expect(peerId.hasInlinePublicKey()).to.equal(false)
+    })
+  })
+
   describe('fromJSON', () => {
     it('full node', async () => {
       const id = await PeerId.create(testOpts)
@@ -271,33 +283,49 @@ describe('PeerId', () => {
 
   it('set privKey (valid)', async () => {
     const peerId = await PeerId.create(testOpts)
+    // @ts-ignore
     peerId.privKey = peerId._privKey
     expect(peerId.isValid()).to.equal(true)
   })
 
   it('set pubKey (valid)', async () => {
     const peerId = await PeerId.create(testOpts)
+    // @ts-ignore
     peerId.pubKey = peerId._pubKey
     expect(peerId.isValid()).to.equal(true)
   })
 
   it('set privKey (invalid)', async () => {
     const peerId = await PeerId.create(testOpts)
-    peerId.privKey = Buffer.from('bufff')
+    // @ts-ignore
+    peerId.privKey = uint8ArrayFromString('bufff')
     expect(peerId.isValid()).to.equal(false)
   })
 
   it('set pubKey (invalid)', async () => {
     const peerId = await PeerId.create(testOpts)
-    peerId.pubKey = Buffer.from('bufff')
+    // @ts-ignore
+    peerId.pubKey = uint8ArrayFromString('bufff')
     expect(peerId.isValid()).to.equal(false)
   })
 
+  it('keys are equal after one is stringified', async () => {
+    const peerId = await PeerId.create(testOpts)
+    const peerId1 = PeerId.createFromB58String(peerId.toB58String())
+    const peerId2 = PeerId.createFromB58String(peerId.toB58String())
+
+    expect(peerId1).to.deep.equal(peerId2)
+
+    peerId1.toString()
+
+    expect(peerId1).to.deep.equal(peerId2)
+  })
+
   describe('returns error via cb instead of crashing', () => {
     const garbage = [
-      Buffer.from('00010203040506070809', 'hex'),
+      uint8ArrayFromString('00010203040506070809', 'base16'),
       {}, null, false, undefined, true, 1, 0,
-      Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
+      uint8ArrayFromString(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
     ]
 
     const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf']

tsconfig.json

@@ -0,0 +1,37 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "target": "ES5",
+        "noImplicitAny": false,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "esModuleInterop": true,
+        "resolveJsonModule": true,
+        "allowJs": true,
+        "checkJs": true,
+        "baseUrl": ".",
+        "paths": {
+            "peer-id": [
+                "./src",
+                "../src",
+            ]
+        },
+        "types": [
+            "node",
+            "mocha",
+            "chai"
+        ],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "./src/index.d.ts",
+    ],
+    "include": [
+        "./test/**/*.spec.js"
+    ]
+}