IPFS Peer ID implementation in JavaScript.
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.
const PeerId = require('peer-id')
const id = await PeerId.create({ bits: 1024, keyType: 'rsa' })
console.log(JSON.stringify(id.toJSON(), null, 2))
{
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
"pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
}
> npm i peer-id
const PeerId = require('peer-id')
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.
const PeerId = require('peer-id')
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>
const PeerId = require('peer-id')
id: Buffer
- The multihash of the publick key asBuffer
privKey: RsaPrivateKey
- The private keypubKey: RsaPublicKey
- The public key
The key format is detailed in libp2p-crypto.
Generates a new Peer ID, complete with public/private keypair.
opts: Object
: Default:{bits: 2048, keyType: 'rsa'}
Returns Promise<PeerId>
.
Creates a Peer ID from hex string representing the key's multihash.
Returns `PeerId.
Creates a Peer ID from a buffer representing the key's multihash.
Returns PeerId
.
Creates a Peer ID from a Base58 string representing the key's multihash.
Returns PeerId
.
publicKey: Buffer
Creates a Peer ID from a buffer containing a public key.
Returns Promise<PeerId>
.
privKey: Buffer
Creates a Peer ID from a buffer containing a private key.
Returns Promise<PeerId>
.
obj.id: String
- The multihash encoded inbase58
obj.pubKey: String
- The public key in protobuf format, encoded inbase64
obj.privKey: String
- The private key in protobuf format, encoded inbase64
Returns Promise<PeerId>
.
buf
is a protocol-buffers encoded PeerId (see marshal()
)
Returns the Peer ID's id
as a hex string.
1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
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>
Returns the Peer ID's id
as a base58 string.
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
Returns an obj
of the form
obj.id: String
- The multihash encoded inbase58
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'
Returns a protocol-buffers encoded version of the id, public key and, if excludePrivateKey
is not set, the private key.
Returns the Peer ID as a printable string without the Qm
prefix.
Example: <peer.ID xxxxxx>
id
can be a PeerId or a Buffer containing the id
MIT