eth-peer-id

> Fork of peer-id where id is a sha3 hash of an Ethereum address.

Lead Maintainer

Dillon Kellar

Table of Contents

- eth-peer-id
- Lead Maintainer
- Table of Contents
- Description
- Example
- Installation
- npm
- Setup
- Node.js
- Browser: Browserify, Webpack, other bundlers
- Browser:


`

API

`js
const PeerId = require('peer-id')
`

Create

$3

- id: Buffer - The multihash of the publick key as Buffer
- privKey: RsaPrivateKey - The private key
- pubKey: RsaPublicKey - The public key

The key format is detailed in libp2p-crypto.

$3

Generates a new Peer ID, complete with public/private keypair.

- opts: Object: Default: {bits: 2048}
- callback: Function

Calls back callback with err, id.

Import

$3

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

$3

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

$3

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

$3

- publicKey: Buffer

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

$3

- privKey: Buffer

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

$3

- obj.id: String - The multihash encoded in base58
- obj.pubKey: String - The public key in protobuf format, encoded in base64
- obj.privKey: String - The private key in protobuf format, encoded in base64

$3

- address: String | Buffer - The Ethereum address.

Export

$3

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

`
1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
`

$3

Returns the Peer ID's id as a buffer.

`

`

$3

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

`
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
`

$3

Returns an obj of the form

- obj.id: String - The multihash encoded in base58
- obj.pubKey: String - The public key in protobuf format, encoded in 'base64'
- obj.privKey: String - The private key in protobuf format, encoded in 'base 64'

$3

Returns the Peer ID as a printable string without the Qm prefix.

Example:

$3

- id` can be a PeerId or a Buffer containing the id

License

MIT