@ellcrys/spell

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Miner | Spell Documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">Spell Documentation</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/miner.html">Miner</a> </li> <li> <a href="miner.miner-1.html">Miner</a> </li> </ul> <h1>Class Miner</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Miner handles mining operations on a node.</p> </div> <dl class="tsd-comment-tags"> <dt>export</dt> <dd></dd> <dt>class</dt> <dd><p>Miner</p> </dd> <dt>extends</dt> <dd><p>{Namespace}</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="namespace.namespace-1.html" class="tsd-signature-type">Namespace</a> <ul class="tsd-hierarchy"> <li> <span class="target">Miner</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="miner.miner-1.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-inherited tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="miner.miner-1.html#client" class="tsd-kind-icon">client</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="miner.miner-1.html#gethashrate" class="tsd-kind-icon">get<wbr>Hashrate</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="miner.miner-1.html#ismining" class="tsd-kind-icon">is<wbr>Mining</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="miner.miner-1.html#numthreads" class="tsd-kind-icon">num<wbr>Threads</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="miner.miner-1.html#setthreads" class="tsd-kind-icon">set<wbr>Threads</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="miner.miner-1.html#start" class="tsd-kind-icon">start</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="miner.miner-1.html#stop" class="tsd-kind-icon">stop</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Miner<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="rpcclient.rpcclient-1.html" class="tsd-signature-type">RPCClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="miner.miner-1.html" class="tsd-signature-type">Miner</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/miner.ts#L15">namespaces/miner.ts:15</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates an instance of Miner.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Miner</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>client: <a href="rpcclient.rpcclient-1.html" class="tsd-signature-type">RPCClient</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="miner.miner-1.html" class="tsd-signature-type">Miner</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="client" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> client</h3> <div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="rpcclient.rpcclient-1.html" class="tsd-signature-type">RPCClient</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="namespace.namespace-1.html">Namespace</a>.<a href="namespace.namespace-1.html#client">client</a></p> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/namespace.ts#L14">namespaces/namespace.ts:14</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="gethashrate" class="tsd-anchor"></a> <h3>get<wbr>Hashrate</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Hashrate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/miner.ts#L89">namespaces/miner.ts:89</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the hashrate of the miner</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Miner</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="ismining" class="tsd-anchor"></a> <h3>is<wbr>Mining</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">is<wbr>Mining<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/miner.ts#L70">namespaces/miner.ts:70</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check whether the miner has is running</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Miner</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="numthreads" class="tsd-anchor"></a> <h3>num<wbr>Threads</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">num<wbr>Threads<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/miner.ts#L108">namespaces/miner.ts:108</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the number of miner threads</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Miner</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setthreads" class="tsd-anchor"></a> <h3>set<wbr>Threads</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Threads<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/miner.ts#L129">namespaces/miner.ts:129</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the number of miner threads to run.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Miner</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>num: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="start" class="tsd-anchor"></a> <h3>start</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/miner.ts#L32">namespaces/miner.ts:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Start the miner on the node</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Miner</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="stop" class="tsd-anchor"></a> <h3>stop</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/namespaces/miner.ts#L51">namespaces/miner.ts:51</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Stop the miner on the node</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>Miner</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/auth.html">Auth</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/ell.html">Ell</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/errors.html">Errors</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/index.html">Index</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/key.html">Key</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/logger.html">Logger</a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/miner.html">Miner</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/namespace.html">Namespace</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/net.html">Net</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/node.html">Node</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/pool.html">Pool</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/rpc.html">RPC</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/rpcclient.html">RPCClient</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/spell.html">Spell</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/state.html">State</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/transactionbuilder.html">Transaction<wbr>Builder</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/txutility.html">Tx<wbr>Utility</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="miner.miner-1.html" class="tsd-kind-icon">Miner</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="miner.miner-1.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="miner.miner-1.html#client" class="tsd-kind-icon">client</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="miner.miner-1.html#gethashrate" class="tsd-kind-icon">get<wbr>Hashrate</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="miner.miner-1.html#ismining" class="tsd-kind-icon">is<wbr>Mining</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="miner.miner-1.html#numthreads" class="tsd-kind-icon">num<wbr>Threads</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="miner.miner-1.html#setthreads" class="tsd-kind-icon">set<wbr>Threads</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="miner.miner-1.html#start" class="tsd-kind-icon">start</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="miner.miner-1.html#stop" class="tsd-kind-icon">stop</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>