@yipsec/rise

Version:

eclipse-resistant network identities

3 lines • 30.6 kB

HTML

<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Class: RiseIdentity</title><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-rise.html">rise</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-rise-EncryptedRiseMessage.html">EncryptedRiseMessage</a></div><div class="sidebar-section-children"><a href="module-rise-RiseIdentity.html">RiseIdentity</a></div><div class="sidebar-section-children"><a href="module-rise-RiseMessage.html">RiseMessage</a></div><div class="sidebar-section-children"><a href="module-rise-RiseSecret.html">RiseSecret</a></div><div class="sidebar-section-children"><a href="module-rise-RiseSolution.html">RiseSolution</a></div><div class="sidebar-section-children"><a href="module-rise-SignedRiseMessage.html">SignedRiseMessage</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="RiseIdentity-title" class="has-anchor"><span class="ancestors"><a href="module-rise.html">rise</a>~</span> RiseIdentity</h1></header><article><div class="container-overview"><h3 class="name has-anchor" id="RiseIdentity"><span class="type-signature"></span>new RiseIdentity<span class="signature">(entropy<span class="signature-attributes">opt</span>, solution<span class="signature-attributes">opt</span>, salt<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Rise <em>private</em> identity bundle. This is the primary interface for using this module. Allows to generate new identities and use them as the context for protected operations.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>entropy</code></td><td class="type"><span class="param-type">Uint8Array</span> |<wbr> <span class="param-type">buffer</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Private key (secp256k1). If absent a new one will be created.</p></td></tr><tr><td class="name"><code>solution</code></td><td class="type"><span class="param-type">RiseSolution</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Equihash solution corresponding to the given private key.</p></td></tr><tr><td class="name"><code>salt</code></td><td class="type"><span class="param-type">Uint8Array</span> |<wbr> <span class="param-type">buffer</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseSolution~SALT</td><td class="description last"><p>Salt used for local pbkdf2 operations locking/unlocking this identity.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line107">line 107</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="fingerprint"><span class="type-signature"></span>fingerprint<span class="type-signature"> :buffer</span></h3><div class="description"><p>160 bit solution hash.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">buffer</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line136">line 136</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="mnemonic"><span class="type-signature"></span>mnemonic<span class="type-signature"> :string</span></h3><div class="description"><p>BIP39 recovery words.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">string</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line119">line 119</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="salt"><span class="type-signature"></span>salt<span class="type-signature"> :Uint8Array|buffer</span></h3><div class="description"><p>Used for local PBKDF2.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Uint8Array</span> |<wbr> <span class="param-type">buffer</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line114">line 114</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="secret"><span class="type-signature"></span>secret<span class="type-signature"> :<a href="module-rise-RiseSecret.html">module:rise~RiseSecret</a></span></h3><div class="description"><p>Underlying secret key.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="module-rise-RiseSecret.html">module:rise~RiseSecret</a></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line124">line 124</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="solution"><span class="type-signature"></span>solution<span class="type-signature"> :<a href="module-rise-RiseSolution.html">module:rise~RiseSolution</a></span></h3><div class="description"><p>Underlying equihash solution.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type"><a href="module-rise-RiseSolution.html">module:rise~RiseSolution</a></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line129">line 129</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".K"><span class="type-signature">(static) </span>K<span class="type-signature"></span></h3><div class="description"><p>Equihash K parameter (length).</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line63">line 63</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".MAGIC"><span class="type-signature">(static) </span>MAGIC<span class="type-signature"></span></h3><div class="description"><p>Rise magic number. Used as message terminator and protocol identitifier.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line77">line 77</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".N"><span class="type-signature">(static) </span>N<span class="type-signature"></span></h3><div class="description"><p>Equihash N parameter (width in bits).</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line49">line 49</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".SALT"><span class="type-signature">(static) </span>SALT<span class="type-signature"></span></h3><div class="description"><p>Rise default salt for pbkdf2 operations.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line91">line 91</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".TEST_K"><span class="type-signature">(static) </span>TEST_K<span class="type-signature"></span></h3><div class="description"><p>Lowered length for testing.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line70">line 70</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".TEST_MAGIC"><span class="type-signature">(static) </span>TEST_MAGIC<span class="type-signature"></span></h3><div class="description"><p>Magic number to segment test network.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line84">line 84</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".TEST_N"><span class="type-signature">(static) </span>TEST_N<span class="type-signature"></span></h3><div class="description"><p>Lowered width for testing.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line56">line 56</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".TEST_Z"><span class="type-signature">(static) </span>TEST_Z<span class="type-signature"></span></h3><div class="description"><p>Lowered difficulty for testing.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line42">line 42</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".Z"><span class="type-signature">(static) </span>Z<span class="type-signature"></span></h3><div class="description"><p>Default difficuly setting. Require this many leading zeroes in solution proofs.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line35">line 35</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="lock"><span class="type-signature"></span>lock<span class="signature">(password)</span><span class="type-signature"> → {buffer}</span></h3><div class="description"><p>Creates an encrypted blob representation of this identity, suitable for persistance to disk.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>password</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>User provided passphrase used to encrypt this identity.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line186">line 186</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">buffer</span></dd></dl></div><h3 class="name has-anchor" id="message"><span class="type-signature"></span>message<span class="signature">(toPublicKey, body<span class="signature-attributes">opt</span>, head<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="module-rise-SignedRiseMessage.html">module:rise~SignedRiseMessage</a>}</span></h3><div class="description"><p>Constructs an encrypted and signed <a href="module-rise-RiseMessage.html">module:rise~RiseMessage</a> for the given public key.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>toPublicKey</code></td><td class="type"><span class="param-type">Uint8Array</span> |<wbr> <span class="param-type">buffer</span></td><td class="attributes"></td><td class="description last"><p>Recipient identity for encryption.</p></td></tr><tr><td class="name"><code>body</code></td><td class="type"><span class="param-type">Object.<string, string></span></td><td class="attributes"><optional><br></td><td class="description last"><p>Key-value pairs to serialize in the message.</p></td></tr><tr><td class="name"><code>head</code></td><td class="type"><span class="param-type">Object.<string, string></span></td><td class="attributes"><optional><br></td><td class="description last"><p>Custom headers to include. <strong>Headers are NOT ENCRYPTED</strong>. Only information that is necessary for routing should be included here.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line208">line 208</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type"><a href="module-rise-SignedRiseMessage.html">module:rise~SignedRiseMessage</a></span></dd></dl></div><h3 class="name has-anchor" id="solve"><span class="type-signature"></span>solve<span class="signature">(n<span class="signature-attributes">opt</span>, k<span class="signature-attributes">opt</span>, epoch<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="module-rise-RiseSolution.html">module:rise~RiseSolution</a>>}</span></h3><div class="description"><p>Creates a new RiseSolution for this identity. This method updates the internal state and will overwrite any previous solution performed in this context.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>n</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~N</td><td class="description last"><p>Width in bits.</p></td></tr><tr><td class="name"><code>k</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~K</td><td class="description last"><p>Solution length.</p></td></tr><tr><td class="name"><code>epoch</code></td><td class="type"><span class="param-type">buffer</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~MAGIC</td><td class="description last"><p>Prepended to public key before hashing. This can be used to segment protocol versions by changing this value which would render solutions generated with a previous or otherwise different value invalid and require a new solution.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line152">line 152</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<<a href="module-rise-RiseSolution.html">module:rise~RiseSolution</a>></span></dd></dl></div><h3 class="name has-anchor" id="toJSON"><span class="type-signature"></span>toJSON<span class="signature">()</span><span class="type-signature"> → {object}</span></h3><div class="description"><p>Returns a plain object representation of this identity, serializable to JSON.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line168">line 168</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id=".generate"><span class="type-signature">(static) </span>generate<span class="signature">(zeroes<span class="signature-attributes">opt</span>, n<span class="signature-attributes">opt</span>, k<span class="signature-attributes">opt</span>, epoch<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="module-rise-RiseIdentity.html">module:rise~RiseIdentity</a>}</span></h3><div class="description"><p>"Mines" a new <a href="module-rise-RiseIdentity.html">module:rise~RiseIdentity</a> and <em>iteratively</em> generates <a href="module-rise-RiseSolution.html">module:rise~RiseSolution</a>s until one is found that satisfies the stated difficulty.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>zeroes</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~Z</td><td class="description last"><p>Difficulty level expressed in number of leading zero bits.</p></td></tr><tr><td class="name"><code>n</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~N</td><td class="description last"><p>Width in bits.</p></td></tr><tr><td class="name"><code>k</code></td><td class="type"><span class="param-type">number</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~K</td><td class="description last"><p>Solution length.</p></td></tr><tr><td class="name"><code>epoch</code></td><td class="type"><span class="param-type">buffer</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~MAGIC</td><td class="description last"><p>Network magic number.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line249">line 249</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type"><a href="module-rise-RiseIdentity.html">module:rise~RiseIdentity</a></span></dd></dl></div><h3 class="name has-anchor" id=".unlock"><span class="type-signature">(static) </span>unlock<span class="signature">(password, data, salt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {modulex:rise~RiseIdentity}</span></h3><div class="description"><p>Decrypts the blob given the password and creates a new instance.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>password</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>User supplied passphrase for decryption.</p></td></tr><tr><td class="name"><code>data</code></td><td class="type"><span class="param-type">buffer</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Binary blob of encrypted identity.</p></td></tr><tr><td class="name"><code>salt</code></td><td class="type"><span class="param-type">buffer</span></td><td class="attributes"><optional><br></td><td class="default">module:rise~RiseIdentity~SALT</td><td class="description last"><p>Salt for pbkdf2.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="index.js.html">index.js</a>, <a href="index.js.html#line221">line 221</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">modulex:rise~RiseIdentity</span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-rise.html">rise</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-rise-EncryptedRiseMessage.html">EncryptedRiseMessage</a></div><div class="sidebar-section-children"><a href="module-rise-RiseIdentity.html">RiseIdentity</a></div><div class="sidebar-section-children"><a href="module-rise-RiseMessage.html">RiseMessage</a></div><div class="sidebar-section-children"><a href="module-rise-RiseSecret.html">RiseSecret</a></div><div class="sidebar-section-children"><a href="module-rise-RiseSolution.html">RiseSolution</a></div><div class="sidebar-section-children"><a href="module-rise-SignedRiseMessage.html">SignedRiseMessage</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>