Generate, import, and export PeerIDs, for use with IPFS.

A Peer ID is the SHA-256 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

var PeerId = require('peer-id')

PeerId.create({ bits: 1024 }, (err, id) => {
  console.log(JSON.stringify(id.toJSON(), null, 2)
})

{
  "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
  "privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
  "pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
}

Installation

npm

> npm i peer-id

Setup

Node.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.

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.

<script src="https://unpkg.com/peer-id/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/peer-id/dist/index.js"></script>

A Peer ID is the SHA-256 multihash of a public key.

See

• libp2p-crypto

static

create(opts: Object?, callback: function (Error, PeerId))

const PeerId = require('peer-id')

PeerId.create((err, id) => {
  if (err) {
    throw err
  }
  console.log('id', JSON.stringify(id))
})

createFromHexString(str: string): PeerId

createFromBytes(buf: Buffer): PeerId

createFromB58String(str: string): PeerId

createFromPubKey(key: (string | Buffer), callback: function (Error, PeerId))

createFromPrivKey(key: (string | Buffer), callback: function (Error, PeerId))

createFromJSON(obj: PeerIdJson, callback: function (Error, PeerId))

instance

constructor(id: Buffer, privKey: RSAPrivateKey?, pubKey: RSAPublickKey?)

id: Buffer

privKey: (RSAPrivateKey | undefined)

pubKey: (RSAPublicKey | undefined)

marshalPubKey(): Buffer

marshalPrivKey(): Buffer

toPrint(): PeerIdJson

toJSON(): PeerIdJson

toHexString(): String

toBytes(): Buffer

toB58String(): String