2016-12-02 14:57:37 +01:00
<!doctype html>
2016-12-02 16:02:12 +01:00
< html > < head > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < title > peer-id - Documentation< / title > < link href = "https://fonts.googleapis.com/css?family=Roboto+Mono:400,500|Roboto:300,500,700" rel = "stylesheet" / > < style > b o d y { m a r g i n : 0 ;
2016-12-02 14:57:37 +01:00
padding: 0;
2016-12-02 16:02:12 +01:00
color: #000;
font-family: Roboto, sans-serif;
font-weight: 300;
line-height: 26px;
2016-12-05 16:16:12 +01:00
font-size: 17px;}*{box-sizing: border-box;
2016-12-09 13:17:30 +01:00
-moz-box-sizing: border-box;}< / style > < / head > < body > < main id = "app" > < div data-radium = "true" > < div style = "box-shadow:0px 2px 3px 0px rgba(0, 0, 0, 0.25);height:65px;width:100%;min-width:100%;margin-left:0px;margin-right:0px;position:fixed;z-index:99;background:#FFFFFF;padding-top:10px;padding-bottom:10px;padding-left:20px;padding-right:20px;" data-radium = "true" > < div style = "margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px;" class = "rmq-87b609c0 rmq-159a7c96 rmq-27601239" data-radium = "true" > < div style = "margin-left:-15px;margin-right:-15px;" data-radium = "true" > < div style = "position:relative;min-height:1px;padding-left:15px;padding-right:15px;float:left;width:50.00000%;" class = "rmq-aa1729d5 rmq-a22eaf97 rmq-1918856d rmq-6156e77b rmq-21ab0466 rmq-a01b93a4 rmq-d226cb7e rmq-5cc71c8" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:inherit;font-size:36px;margin-right:20px;" > < g > < path d = "m30 22.5h-5c-1.3 0-2.5 1.3-2.5 2.5h10c0-1.3-1.2-2.5-2.5-2.5z m-2.1-16.2c-6.6 0-8.2 1.2-9.1 2.1-1-0.9-2.6-2.1-9.2-2.1s-9.6 1.7-9.6 3v22.9c1.1-0.6 4.6-1.9 8.4-2.2 4.4-0.4 9.1 0.4 9.1 1.2 0 0.7 0.3 1.3 1.2 1.3h0.1c0.9 0 1.2-0.6 1.2-1.2 0-0.9 4.6-1.7 9.1-1.3 3.7 0.3 7.3 1.6 8.4 2.2v-22.9c0-1.3-3.1-3-9.6-3z m-10.4 22.3c-1.2-0.6-4-1.1-7.5-1.1s-6.6 0.5-7.5 1.1v-17.3s2.5-2.4 7.5-2.4 7.5 1.1 7.5 2.4v17.3z m17.5 0c-0.9-0.6-4-1.1-7.5-1.1s-6.3 0.5-7.5 1.1v-17.3s2.5-2.4 7.5-2.4 7.5 1.1 7.5 2.4v17.3z m-5-11.1h-5c-1.3 0-2.5 1.3-2.5 2.5h10c0-1.3-1.2-2.5-2.5-2.5z m0-5h-5c-1.3 0-2.5 1.3-2.5 2.5h10c0-1.3-1.2-2.5-2.5-2.5z m-17.5 5h-5c-1.2 0-2.5 1.2-2.5 2.5h10c0-1.2-1.2-2.5-2.5-2.5z m0 5h-5c-1.2 0-2.5 1.2-2.5 2.5h10c0-1.2-1.2-2.5-2.5-2.5z m0-10h-5c-1.2 0-2.5 1.2-2.5 2.5h10c0-1.2-1.2-2.5-2.5-2.5z" > < / path > < / g > < / svg > < div style = "display:inline-block;" data-radium = "true" > < div style = "text-transform:uppercase;font-family:Roboto, sans-serif;" data-radium = "true" > peer-id< / div > < div style = "font-family:Roboto Mono, Menlo, Monaco, Courier, monospace;font-weight:300;" data-radium = "true" > 0.8.0< / div > < / div > < / div > < div style = "position:relative;min-height:1px;padding-left:15px;padding-right:15px;float:right !important;width:25.00000%;text-align:right;font-size:36px;" class = "rmq-aa1729d5 rmq-a22eaf97 rmq-1918856d rmq-6156e77b rmq-77267d84 rmq-5c0c1446 rmq-4605701c rmq-34ee8e6a" data-radium = "true" > < a href = "https://github.com/libp2p/js-peer-id" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m20 0c-11 0-20 9-20 20 0 8.8 5.7 16.3 13.7 19 1 0.2 1.3-0.5 1.3-1 0-0.5 0-2 0-3.7-5.5 1.2-6.7-2.4-6.7-2.4-0.9-2.3-2.2-2.9-2.2-2.9-1.9-1.2 0.1-1.2 0.1-1.2 2 0.1 3.1 2.1 3.1 2.1 1.7 3 4.6 2.1 5.8 1.6 0.2-1.3 0.7-2.2 1.3-2.7-4.5-0.5-9.2-2.2-9.2-9.8 0-2.2 0.8-4 2.1-5.4-0.2-0.5-0.9-2.6 0.2-5.3 0 0 1.7-0.5 5.5 2 1.6-0.4 3.3-0.6 5-0.6 1.7 0 3.4 0.2 5 0.7 3.8-2.6 5.5-2.1 5.5-2.1 1.1 2.8 0.4 4.8 0.2 5.3 1.3 1.4 2.1 3.2 2.1 5.4 0 7.6-4.7 9.3-9.2 9.8 0.7 0.6 1.4 1.9 1.4 3.7 0 2.7 0 4.9 0 5.5 0 0.6 0.3 1.2 1.3 1 8-2.7 13.7-10.2 13.7-19 0-11-9-20-20-20z" > < / path > < / g > < / svg > < / a > < / div > < div style = "clear:both;" data-radium = "true" > < / div > < / div > < div style = "clear:both;" data-radium = "true" > < / div > < / div > < / div > < div style = "margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px;padding-top:104px;" class = "rmq-87b609c0 rmq-159a7c96 rmq-27601239" data-radium = "true" > < div style = "margin-left:-15px;margin-right:-15px;" data-radium = "true" > < div style = "position:fixed;min-height:1px;padding-left:15px;padding-right:15px;float:left;width:8.33333%;height:80%;max-width:300px;" class = "rmq-aa1729d5 rmq-a22eaf97 rmq-1918856d rmq-6156e77b rmq-5c4c5b38 rmq-5c0c1446 rmq-4605701c rmq-34ee8e6a rmq-35757987 rmq-f09e82ae" data-radium = "true" > < div style = "border-radius:4px;border:1px solid #e6e9ed;padding-top:0;padding-bottom:0;margin-top:26px;font-family:Roboto, sans-serif;font-weight:500;font-size:15px;line-height:18px;max-height:70vh;overflow-x:auto;" data-radium = "true" > < ul style = "list-style:none;margin-top:0;margin-bottom:0;pad
2016-12-02 16:02:12 +01:00
font-weight: 300;}h1{font-size: 48px;
line-height: 72px;}h2{font-size: 24px;
line-height: 36px;}h3{font-size: 19px;
line-height: 29px;
font-weight: 400;}h4{font-size: 17px;
line-height: 22px;
font-weight: 400;}a{text-decoration: none;
2016-12-02 14:57:37 +01:00
color: #00AAFF;
:hover: [object Object];}a.anchor:before{content: "";
display: block;
height: 100px;
2016-12-02 16:02:12 +01:00
margin: -80px 0 0;}.content blockquote{padding-left: 20px;
margin: 0;
border-left: 4px solid #eee;}.content ul, content li{list-style: none;}.content ul li:before{color: #CCC;
float: left;
margin-left: -20px;
margin-top: 1px;
content: "•";}pre.hljs, pre > code{font-family: Roboto Mono, Menlo, Monaco, Courier, monospace;
2016-12-02 14:57:37 +01:00
display: block;
padding: 12px 15px 12px 15px;
border-radius: 4px;
box-shadow: inset 0 0 0 1px rgba(0, 0, 0, 0.1);
margin-bottom: 30px;
position: relative;
overflow-x: auto;
font-size: 13px;
2016-12-02 16:02:12 +01:00
color: #666;
2016-12-02 14:57:37 +01:00
white-space: pre;}code{font-family: Roboto Mono, Menlo, Monaco, Courier, monospace;
display: inline;
font-size: 13px;
font-weight: 400;
margin: 0 2px;
padding: 1px 6px;
box-shadow: 0 0 0 1px #DDD;
2016-12-02 16:02:12 +01:00
white-space: nowrap;
2016-12-02 16:43:04 +01:00
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;
2016-12-09 13:17:30 +01:00
font-weight: bold;}.hljs-deletion{background: #fdd;}.hljs-addition{background: #dfd;}.hljs-emphasis{font-style: italic;}.hljs-strong{font-weight: bold;}< / style > < div style = "margin-bottom:104px;" data-radium = "true" > < h1 data-radium = "true" > < a class = "anchor" name = "introduction" > < / a > Introduction< / h1 > < div > < p > Generate, import, and export PeerIDs, for use with < a href = "https://github.com/ipfs/ipfs" > IPFS< / a > .< / p >
2016-12-05 20:37:22 +01:00
< blockquote >
< p > A Peer ID is the SHA-256 < a href = "https://github.com/multiformats/multihash" > multihash< / a > of a public key.< / p >
< p > 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.< / p >
< / blockquote >
< h2 > Example< / h2 >
< pre class = 'hljs' > < span class = "hljs-keyword" > var< / span > PeerId = < span class = "hljs-built_in" > require< / span > (< span class = "hljs-string" > 'peer-id'< / span > )
PeerId.create({ < span class = "hljs-attr" > bits< / span > : < span class = "hljs-number" > 1024< / span > }, (err, id) => {
< span class = "hljs-built_in" > console< / span > .log(< span class = "hljs-built_in" > JSON< / span > .stringify(id.toJSON(), < span class = "hljs-literal" > null< / span > , < span class = "hljs-number" > 2< / span > )
})< / pre >
< pre class = 'hljs' > {
< span class = "hljs-attr" > "id"< / span > : < span class = "hljs-string" > "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi"< / span > ,
< span class = "hljs-attr" > "privKey"< / span > : < span class = "hljs-string" > "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv.."< / span > ,
< span class = "hljs-attr" > "pubKey"< / span > : < span class = "hljs-string" > "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."< / span >
}< / pre >
< h2 > Installation< / h2 >
< h3 > npm< / h3 >
< pre class = 'hljs' > > npm i peer-id< / pre >
< h2 > Setup< / h2 >
< h3 > Node.js< / h3 >
< pre class = 'hljs' > < span class = "hljs-keyword" > var< / span > PeerId = < span class = "hljs-built_in" > require< / span > (< span class = "hljs-string" > 'peer-id'< / span > )< / pre >
< h3 > Browser: Browserify, Webpack, other bundlers< / h3 >
< p > 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.< / p >
< pre class = 'hljs' > < span class = "hljs-keyword" > var< / span > PeerId = < span class = "hljs-built_in" > require< / span > (< span class = "hljs-string" > 'peer-id'< / span > )< / pre >
< h3 > Browser: < code > < script>< / code > Tag< / h3 >
< p > Loading this module through a script tag will make the < code > PeerId< / code > obj available in
the global namespace.< / p >
< pre class = 'hljs' > < span class = "hljs-tag" > < < span class = "hljs-name" > script< / span > < span class = "hljs-attr" > src< / span > =< span class = "hljs-string" > "https://unpkg.com/peer-id/dist/index.min.js"< / span > > < / span > < span class = "undefined" > < / span > < span class = "hljs-tag" > < /< span class = "hljs-name" > script< / span > > < / span >
< span class = "hljs-comment" > < !-- OR --> < / span >
< span class = "hljs-tag" > < < span class = "hljs-name" > script< / span > < span class = "hljs-attr" > src< / span > =< span class = "hljs-string" > "https://unpkg.com/peer-id/dist/index.js"< / span > > < / span > < span class = "undefined" > < / span > < span class = "hljs-tag" > < /< span class = "hljs-name" > script< / span > > < / span > < / pre >
2016-12-09 13:17:30 +01:00
< / div > < / div > < div style = "margin-bottom:104px;" data-radium = "true" > < h1 data-radium = "true" > < a class = "anchor" name = "peerid" > < / a > PeerId< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L24-L323" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h1 > < div > < p > A Peer ID is the SHA-256
2016-12-02 14:57:37 +01:00
< a href = "https://github.com/multiformats/multihash" > multihash< / a > of a
public key.< / p >
< / div > < div style = "display:inline;" data-radium = "true" > < h4 > See< / h4 > < ul data-radium = "true" > < li > < div > < p > < a href = "htttps://github.com/libp2p/js-libp2p-crypto" > libp2p-crypto< / a > < / p >
2016-12-09 13:17:30 +01:00
< / div > < / li > < / ul > < / div > < div data-radium = "true" > < h2 style = "text-transform:uppercase;" data-radium = "true" > static< / h2 > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridcreate" > < / a > PeerId.create< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L160-L180" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > create(opts: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" > Object< / a > ?, callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )): < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Create a new < code > PeerId< / code > by generating a new public/private keypair.< / p >
2016-12-06 13:02:54 +01:00
< / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > opts: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" > Object< / a > ?< / code > : < div style = "display:inline-block;" data-radium = "true" > Configuration object.
< / div > < / li > < li style = "padding-bottom:13px;" data-radium = "true" > < code > opts.bits: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" > number< / a > ? (=2048)< / code > : < div style = "display:inline-block;" data-radium = "true" > How many bits to use for the RSA key generation.
< / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )< / code > : < div style = "display:inline-block;" data-radium = "true" > Node.js style callback.
< / div > < / li > < / div > < / ol > < / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < span >
2016-12-05 20:37:22 +01:00
< / span > < / div > < / div > < div data-radium = "true" > < div data-radium = "true" > < h4 > Example< / h4 > < pre > < code > < span class = "hljs-keyword" > const< / span > PeerId = < span class = "hljs-built_in" > require< / span > (< span class = "hljs-string" > 'peer-id'< / span > )
2016-12-02 14:57:37 +01:00
PeerId.create(< span class = "hljs-function" > (< span class = "hljs-params" > err, id< / span > ) => < / span > {
< span class = "hljs-keyword" > if< / span > (err) {
< span class = "hljs-keyword" > throw< / span > err
}
< span class = "hljs-built_in" > console< / span > .log(< span class = "hljs-string" > 'id'< / span > , < span class = "hljs-built_in" > JSON< / span > .stringify(id))
2016-12-09 13:17:30 +01:00
})< / code > < / pre > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridcreatefromhexstring" > < / a > PeerId.createFromHexString< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L188-L190" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > createFromHexString(str: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > ): < a href = "#peerid" > PeerId< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Creates a Peer ID from hex string representing the key's multihash.< / p >
2016-12-06 13:02:54 +01:00
< / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > str: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > < / code > : < div style = "display:inline-block;" data-radium = "true" > Hex encoded id
< / div > < / li > < / div > < / ol > < / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "#peerid" > PeerId< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridcreatefrombytes" > < / a > PeerId.createFromBytes< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L198-L200" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > createFromBytes(buf: < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > ): < a href = "#peerid" > PeerId< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Creates a Peer ID from a buffer representing the key's multihash.< / p >
2016-12-06 13:02:54 +01:00
< / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > buf: < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < / ol > < / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "#peerid" > PeerId< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridcreatefromb58string" > < / a > PeerId.createFromB58String< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L209-L211" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > createFromB58String(str: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > ): < a href = "#peerid" > PeerId< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Creates a Peer ID from a < code > base58< / code > string representing the
2016-12-02 14:57:37 +01:00
key's multihash.< / p >
2016-12-06 13:02:54 +01:00
< / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > str: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > < / code > : < div style = "display:inline-block;" data-radium = "true" > < code > base58< / code >
2016-12-02 14:57:37 +01:00
encoded id
2016-12-06 13:02:54 +01:00
< / div > < / li > < / div > < / ol > < / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "#peerid" > PeerId< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridcreatefrompubkey" > < / a > PeerId.createFromPubKey< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L220-L238" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > createFromPubKey(key: (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > | < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > ), callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )): < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Creates a Peer ID from a buffer containing a public key.< / p >
2016-12-06 13:02:54 +01:00
< / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > key: (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > | < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > )< / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )< / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < / ol > < / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridcreatefromprivkey" > < / a > PeerId.createFromPrivKey< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L248-L270" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > createFromPrivKey(key: (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > | < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > ), callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )): < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Creates a Peer ID from a buffer containing a private key.< / p >
2016-12-06 13:02:54 +01:00
< / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > key: (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > | < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > )< / code > : < div style = "display:inline-block;" data-radium = "true" > The private key, if passed as
2016-12-02 14:57:37 +01:00
string
< code > base64< / code >
encoding is assumed.
2016-12-06 13:02:54 +01:00
< / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )< / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < / ol > < / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridcreatefromjson" > < / a > PeerId.createFromJSON< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L279-L322" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > createFromJSON(obj: < a href = "#peeridjson" > PeerIdJson< / a > , callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )): < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Import a < code > PeerId< / code > from a serialized JSON object.< / p >
2016-12-06 13:02:54 +01:00
< / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > obj: < a href = "#peeridjson" > PeerIdJson< / a > < / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > callback: function (< a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error" > Error< / a > , < a href = "#peerid" > PeerId< / a > )< / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < / ol > < / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < / div > < div data-radium = "true" > < h2 style = "text-transform:uppercase;" data-radium = "true" > instance< / h2 > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridconstructor" > < / a > constructor< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L30-L43" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > constructor(id: < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > , privKey: RSAPrivateKey?, pubKey: RSAPublickKey?)< / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > id: < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > privKey: RSAPrivateKey?< / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > pubKey: RSAPublickKey?< / code > : < div style = "display:inline-block;" data-radium = "true" > < / div > < / li > < / div > < / ol > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridid" > < / a > PeerId.prototype.id< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L40-L40" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > id: < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridprivkey" > < / a > PeerId.prototype.privKey< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L50-L52" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > privKey: (RSAPrivateKey | < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > )< / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > The private key of this id, if it exists.< / p >
< / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridpubkey" > < / a > PeerId.prototype.pubKey< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L59-L67" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > pubKey: (RSAPublicKey | < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" > undefined< / a > )< / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > The public key of this id, if it exists.< / p >
< / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridmarshalpubkey" > < / a > PeerId.prototype.marshalPubKey< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L74-L78" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > marshalPubKey(): < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Create the protobuf version of the public key,
2016-12-02 14:57:37 +01:00
matching go-ipfs formatting.< / p >
< / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > < span > The marshalled public key
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridmarshalprivkey" > < / a > PeerId.prototype.marshalPrivKey< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L85-L89" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > marshalPrivKey(): < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Create the protobuf version of the private key,
2016-12-02 14:57:37 +01:00
matching go-ipfs formatting.< / p >
< / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridtoprint" > < / a > PeerId.prototype.toPrint< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L96-L98" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > toPrint(): < a href = "#peeridjson" > PeerIdJson< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Alias for < code > toJSON< / code > .< / p >
2016-12-02 14:57:37 +01:00
< / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "#peeridjson" > PeerIdJson< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridtojson" > < / a > PeerId.prototype.toJSON< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L106-L112" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > toJSON(): < a href = "#peeridjson" > PeerIdJson< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Return the jsonified version of the key, matching the formatting
2016-12-02 14:57:37 +01:00
of go-ipfs for its config file.< / p >
< / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "#peeridjson" > PeerIdJson< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridtohexstring" > < / a > PeerId.prototype.toHexString< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L119-L121" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > toHexString(): < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > String< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Returns the Peer ID's < code > id< / code > as a hex string.< / p >
2016-12-02 14:57:37 +01:00
< / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > String< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridtobytes" > < / a > PeerId.prototype.toBytes< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L128-L130" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > toBytes(): < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Returns the Peer ID's < code > id< / code > as a buffer.< / p >
2016-12-02 14:57:37 +01:00
< / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://nodejs.org/api/buffer.html" > Buffer< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < div style = "margin-bottom:52px;" data-radium = "true" > < h3 data-radium = "true" > < a class = "anchor" name = "peeridtob58string" > < / a > PeerId.prototype.toB58String< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L137-L139" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h3 > < pre > < code > toB58String(): < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > String< / a > < / code > < / pre > < div style = "margin-top:13px;margin-bottom:13px;" data-radium = "true" > < p > Returns the Peer ID's < code > id< / code > as a base58 string.< / p >
2016-12-02 14:57:37 +01:00
< / div > < div data-radium = "true" > < h4 > Returns< / h4 > < div data-radium = "true" > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > String< / a > < / code > < span >
2016-12-09 13:17:30 +01:00
< / span > < / div > < / div > < / div > < / div > < / div > < div style = "margin-bottom:104px;" data-radium = "true" > < h1 data-radium = "true" > < a class = "anchor" name = "peeridjson" > < / a > PeerIdJson< a href = "https://github.com/libp2p/js-peer-id/blob/3ef704ba32a97a9da26a1f821702cdd3f09c778f/src/index.js#L24-L323" title = "src/index.js" style = "float:right;" data-radium = "true" > < svg fill = "currentColor" preserveAspectRatio = "xMidYMid meet" height = "1em" width = "1em" viewBox = "0 0 40 40" style = "vertical-align:middle;" > < g > < path d = "m26.3 7.5l-3.8 3.8 8.8 8.7-8.8 8.8 3.8 3.7 11.2-12.5-11.2-12.5z m-12.5 0l-11.3 12.5 11.3 12.5 3.7-3.7-8.7-8.8 8.7-8.7-3.7-3.8z" > < / path > < / g > < / svg > < / a > < / h1 > < div > < / div > < div data-radium = "true" > < h4 > Parameters< / h4 > < ol style = "list-style:none;margin-left:0;padding-left:0;" data-radium = "true" > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > id: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > < / code > : < div style = "display:inline-block;" data-radium = "true" > < code > Base58< / code >
2016-12-05 20:37:22 +01:00
encoded peer id
2016-12-06 13:02:54 +01:00
< / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > privKey: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > ?< / code > : < div style = "display:inline-block;" data-radium = "true" > The RSA private key in protobuf format, encoded in
2016-12-05 20:37:22 +01:00
< code > base64< / code >
.
2016-12-06 13:02:54 +01:00
< / div > < / li > < / div > < div data-radium = "true" > < li style = "padding-bottom:13px;" data-radium = "true" > < code > pubKey: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" > string< / a > ?< / code > : < div style = "display:inline-block;" data-radium = "true" > The RSA public key in protobuf format, encoded in
2016-12-05 20:37:22 +01:00
< code > base64< / code >
.
2016-12-06 13:02:54 +01:00
< / div > < / li > < / div > < / ol > < / div > < / div > < / div > < / div > < div style = "clear:both;" data-radium = "true" > < / div > < / div > < div style = "clear:both;" data-radium = "true" > < / div > < / div > < style > @ m e d i a ( m i n - w i d t h : 7 6 8 p x ) a n d ( m a x - w i d t h : 9 9 1 p x ) { . r m q - 8 7 b 6 0 9 c 0 { w i d t h : 7 5 0 p x ! i m p o r t a n t ; } }
2016-12-05 14:56:05 +01:00
@media (min-width: 992px) and (max-width: 1199px){ .rmq-159a7c96{width: 970px !important;}}
2016-12-02 14:57:37 +01:00
@media (min-width: 1200px){ .rmq-27601239{width: 1170px !important;}}
2016-12-05 14:56:05 +01:00
@media (min-width: 480px) and (max-width: 767px){ .rmq-aa1729d5{float: left !important;}}
@media (min-width: 768px) and (max-width: 991px){ .rmq-a22eaf97{float: left !important;}}
@media (min-width: 992px) and (max-width: 1199px){ .rmq-1918856d{float: left !important;}}
2016-12-02 14:57:37 +01:00
@media (min-width: 1200px){ .rmq-6156e77b{float: left !important;}}
2016-12-05 14:56:05 +01:00
@media (min-width: 480px) and (max-width: 767px) { .rmq-21ab0466{width: 50.00000% !important;}}
@media (min-width: 768px) and (max-width: 991px) { .rmq-a01b93a4{width: 50.00000% !important;}}
2016-12-05 16:16:12 +01:00
@media (min-width: 992px) and (max-width: 1199px) { .rmq-d226cb7e{width: 50.00000% !important;}}
@media (min-width: 1200px) { .rmq-5cc71c8{width: 50.00000% !important;}}
2016-12-06 13:02:54 +01:00
@media (min-width: 480px) and (max-width: 767px) { .rmq-77267d84{width: 25.00000% !important;}}
2016-12-05 14:56:05 +01:00
@media (min-width: 768px) and (max-width: 991px) { .rmq-5c0c1446{width: 25.00000% !important;}}
@media (min-width: 992px) and (max-width: 1199px) { .rmq-4605701c{width: 25.00000% !important;}}
2016-12-02 16:43:04 +01:00
@media (min-width: 1200px) { .rmq-34ee8e6a{width: 25.00000% !important;}}
2016-12-06 13:02:54 +01:00
@media (min-width: 480px) and (max-width: 767px) { .rmq-5c4c5b38{width: 8.33333% !important;}}
2016-12-05 14:56:05 +01:00
@media (max-width: 479px){ .rmq-35757987{display: none !important;}}
@media (min-width: 480px) and (max-width: 767px) { .rmq-f09e82ae{display: none !important;}}
@media (min-width: 480px) and (max-width: 767px) { .rmq-89bb2272{width: 100.00000% !important;}}
@media (min-width: 768px) and (max-width: 991px) { .rmq-2d0e68c6{width: 66.66667% !important;}}
@media (min-width: 992px) and (max-width: 1199px) { .rmq-3752549c{width: 66.66667% !important;}}
2016-12-02 16:43:04 +01:00
@media (min-width: 1200px) { .rmq-3b9282ea{width: 66.66667% !important;}}
2016-12-05 14:56:05 +01:00
@media (min-width: 768px) and (max-width: 991px) { .rmq-4d29a8df{left: 33.33333% !important;}}
@media (min-width: 992px) and (max-width: 1199px) { .rmq-ea7683a5{left: 33.33333% !important;}}
2016-12-06 13:02:54 +01:00
@media (min-width: 1200px) { .rmq-ad95cc33{left: 33.33333% !important;}}< / style > < / div > < / main > < / body > < / html >
