peer-id

IPFS Peer ID implementation in JavaScript.

Description

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')
var bs58 = require('bs58')

var id = PeerId.create({ bits: 32 })

console.log('id        ', id.toB58String())
console.log('priv key  ', bs58.encode(id.privKey))
console.log('pub key   ', bs58.encode(id.pubKey))

id         QmeeLFb92nkZJGj3gXLqXrEMzCMYs6uBgQLVNbrcXEvYXk
priv key   6ibrcPAbevzvPpkq6EA6XmLyuhmUrJrEvUfgQDtEiSEPzGnGU8Ejwf6b11DVm6opnFGo
pub key    2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE

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://npmcdn.com/peer-id/dist/index.min.js"></script>
<!-- OR -->
<script src="https://npmcdn.com/peer-id/dist/index.js"></script>

API

const PeerId = require('peer-id')

Create

PeerId.create()

Generates a new Peer ID, complete with public/private keypair. A Peer ID has the following properties:

• pubKey - Buffer containing the public key bytes
• privKey - Buffer containing the private key bytes
• id - Buffer containing the multihash bytes

Import

PeerId.createFromHexString(str)

Creates a Peer ID from hex string representing the key's multihash.

PeerId.createFromBytes(buf)

Creates a Peer ID from a buffer representing the key's multihash.

PeerId.createFromB58String(str)

Creates a Peer ID from a Base58 string representing the key's multihash.

PeerId.createFromPubKey(pubKey)

Creates a Peer ID from a buffer containing a public key.

PeerId.createFromPrivKey(privKey)

Creates a Peer ID from a buffer containing a private key.

Export

id.toPrint()

Returns an object with the ID's properties in hex format:

{
  id: 'QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi',
  privKey: '080012a609308204a20201000282010100a608889914da08959d3a3db0734cee812c96...',
  pubKey: '080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010...'
}

id.toHexString()

Returns the Peer ID's id as a hex string.

1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f

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

id.toB58String()

Returns the Peer ID's id as a base58 string.

QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi

License

MIT