peer-id
0.8.0

PeerIdJson

Parameters

Name
Description
id: string
Base58 encoded peer id
privKey: string?
The RSA private key in protobuf format, encoded in base64 .
pubKey: string?
The RSA public key in protobuf format, encoded in base64 .

PeerId

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

static

PeerId.create

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

Create a new PeerId by generating a new public/private keypair.

Parameters

Name
Description
opts: Object?
Configuration object.
opts.bits: number? (=2048)
How many bits to use for the RSA key generation.
callback: function (Error, PeerId)
Node.js style callback.

Example

const PeerId = require('peer-id')

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

PeerId.createFromHexString

createFromHexString(str: string): PeerId

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

Parameters

Name
Description
str: string
Hex encoded id

Returns

PeerId.createFromBytes

createFromBytes(buf: Buffer): PeerId

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

Parameters

Name
Description
buf: Buffer

Returns

PeerId.createFromB58String

createFromB58String(str: string): PeerId

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

Parameters

Name
Description
str: string
base58 encoded id

Returns

PeerId.createFromPubKey

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

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

Parameters

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

PeerId.createFromPrivKey

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

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

Parameters

Name
Description
key: (string | Buffer)
The private key, if passed as string base64 encoding is assumed.
callback: function (Error, PeerId)

PeerId.createFromJSON

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

Import a PeerId from a serialized JSON object.

Parameters

Name
Description
callback: function (Error, PeerId)

instance

constructor

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

Parameters

Name
Description
id: Buffer
privKey: RSAPrivateKey?
pubKey: RSAPublickKey?

PeerId.prototype.id

id

PeerId.prototype.privKey

privKey

The private key of this id, if it exists.

PeerId.prototype.pubKey

pubKey

The public key of this id, if it exists.

PeerId.prototype.marshalPubKey

marshalPubKey(): Buffer

Create the protobuf version of the public key, matching go-ipfs formatting.

Returns

Buffer The marshalled public key

Throws

Error Failure

PeerId.prototype.marshalPrivKey

marshalPrivKey(): Buffer

Create the protobuf version of the private key, matching go-ipfs formatting.

Returns

PeerId.prototype.toPrint

toPrint(): PeerIdJson

Alias for toJSON.

Returns

PeerId.prototype.toJSON

toJSON(): PeerIdJson

Return the jsonified version of the key, matching the formatting of go-ipfs for its config file.

Returns

PeerId.prototype.toHexString

toHexString(): String

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

Returns

PeerId.prototype.toBytes

toBytes(): Buffer

Returns the Peer ID's id as a buffer.

Returns

PeerId.prototype.toB58String

toB58String(): String

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

Returns