Introduction
Generate, import, and export PeerIDs, for use with IPFS.
+border-radius: 4px;}.hljs{display: block; +overflow-x: auto;}.hljs-comment, .hljs-quote{color: #998; +font-style: italic;}.hljs-keyword, .hljs-selector-tag, .hljs-subst{color: #333; +font-weight: bold;}.hljs-number, .hljs-literal, .hljs-variable, .hljs-template-variable, .hljs-tag .hljs-attr{color: #008080;}.hljs-string, .hljs-doctag{color: #d14;}.hljs-title, .hljs-section, .hljs-selector-id{color: #900; +font-weight: bold;}.hljs-subst{font-weight: normal;}.hljs-type, .hljs-class .hljs-title{color: #458; +font-weight: bold;}.hljs-tag, .hljs-name, .hljs-attribute{color: #000080; +font-weight: normal;}.hljs-regexp, .hljs-link{color: #009926;}.hljs-symbol, .hljs-bullet{color: #990073;}.hljs-built_in, .hljs-builtin-name{color: #0086b3;}.hljs-meta{color: #999; +font-weight: bold;}.hljs-deletion{background: #fdd;}.hljs-addition{background: #dfd;}.hljs-emphasis{font-style: italic;}.hljs-strong{font-weight: bold;}Introduction
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.
@@ -75,11 +82,11 @@ 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>-
PeerId
A Peer ID is the SHA-256 multihash of a public key.
See
static
PeerId.create
create(opts: Object?, callback: function (Error, PeerId))Create a new PeerId by generating a new public/private keypair.
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.
@@ -90,44 +97,44 @@ PeerId.create((err, idthrow err
}
console.log('id', JSON.stringify(id))
-})PeerId.createFromHexStringCreates a Peer ID from hex string representing the key's multihash. +})PeerId.createFromHexStringCreates a Peer ID from hex string representing the key's multihash. Parameters
ReturnsPeerId
-PeerId.createFromBytesCreates a Peer ID from a buffer representing the key's multihash. +PeerId.createFromBytesCreates a Peer ID from a buffer representing the key's multihash. Parameters
ReturnsPeerId
-PeerId.createFromB58StringCreates a Peer ID from a PeerId.createFromB58StringCreates a Peer ID from a Parameters
ReturnsPeerId
-PeerId.createFromPubKeyCreates a Peer ID from a buffer containing a public key. -PeerId.createFromPrivKeyCreates a Peer ID from a buffer containing a private key. +PeerId.createFromPubKeyCreates a Peer ID from a buffer containing a public key. +PeerId.createFromPrivKeyCreates a Peer ID from a buffer containing a private key. PeerId.createFromJSONImport a Parameters
instanceconstructorParameters
PeerId.prototype.idPeerId.prototype.privKeyThe private key of this id, if it exists. -PeerId.prototype.pubKeyThe private key of this id, if it exists. -PeerId.prototype.marshalPubKeyCreate the protobuf version of the public key, + |
PeerId.createFromJSON
createFromJSON(obj: PeerIdJson, callback: function (Error, PeerId))Import a PeerId from a serialized JSON object.
Parameters
| Name | Description |
|---|---|
obj: PeerIdJson |
instance
constructor
constructor(id: Buffer, privKey: RSAPrivateKey?, pubKey: RSAPublickKey?)Parameters
| Name | Description |
|---|---|
id: Buffer | |
privKey: RSAPrivateKey? | |
pubKey: RSAPublickKey? |
PeerId.prototype.id
id: BufferPeerId.prototype.privKey
privKey: (RSAPrivateKey | undefined)The private key of this id, if it exists.
+PeerId.prototype.pubKey
pubKey: (RSAPublicKey | undefined)The private key of this id, if it exists.
+PeerId.prototype.marshalPubKey
marshalPubKey(): BufferCreate the protobuf version of the public key, matching go-ipfs formatting.
Returns
Buffer The marshalled public key
Throws
Error Failure
-PeerId.prototype.marshalPrivKey
marshalPrivKey(): BufferCreate the protobuf version of the private key, +
PeerId.prototype.toJSON
toJSON(): PeerIdJsonReturn the jsonified version of the key, matching the formatting +
PeerId.prototype.toJSON
toJSON(): PeerIdJsonReturn the jsonified version of the key, matching the formatting of go-ipfs for its config file.
Returns
PeerIdJson
Parameters
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
id: string | Base58
+PeerIdJsonParameters
|