turtlecoin-cryptonote-util

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>turtlecoin-cryptonote-util</title> <meta name="description" content="Documentation for turtlecoin-cryptonote-util"> <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.json" 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">turtlecoin-cryptonote-util</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> </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> </ul> <h1>turtlecoin-cryptonote-util</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class"><a href="classes/cryptonoteutils.html" class="tsd-kind-icon">Crypto<wbr>Note<wbr>Utils</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function"><a href="globals.html#address_decode" class="tsd-kind-icon">address_<wbr>decode</a></li> <li class="tsd-kind-function"><a href="globals.html#construct_block_blob" class="tsd-kind-icon">construct_<wbr>block_<wbr>blob</a></li> <li class="tsd-kind-function"><a href="globals.html#convert_blob" class="tsd-kind-icon">convert_<wbr>blob</a></li> <li class="tsd-kind-function"><a href="globals.html#convert_blob_bb" class="tsd-kind-icon">convert_<wbr>blob_<wbr>bb</a></li> <li class="tsd-kind-function"><a href="globals.html#get_block_id" class="tsd-kind-icon">get_<wbr>block_<wbr>id</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="address_decode" class="tsd-anchor"></a> <h3>address_<wbr>decode</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">address_<wbr>decode<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/turtlecoin/node-cryptonote-util/blob/9cd8b14/typescript/index.ts#L12">index.ts:12</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Calculates the address prefix in decimal form from the given address</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>address: <span class="tsd-signature-type">Buffer</span></h5> <div class="tsd-comment tsd-typography"> <p>the public wallet address to decode</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="construct_block_blob" class="tsd-anchor"></a> <h3>construct_<wbr>block_<wbr>blob</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">construct_<wbr>block_<wbr>blob<span class="tsd-signature-symbol">(</span>block<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><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">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/turtlecoin/node-cryptonote-util/blob/9cd8b14/typescript/index.ts#L23">index.ts:23</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Constructs a new "final" block that can be submitted to the network from the original block in the block template and the nonce value found by the miner(s)</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>block: <span class="tsd-signature-type">Buffer</span></h5> <div class="tsd-comment tsd-typography"> <p>the block template blob</p> </div> </li> <li> <h5>nonce: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="convert_blob" class="tsd-anchor"></a> <h3>convert_<wbr>blob</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">convert_<wbr>blob<span class="tsd-signature-symbol">(</span>template<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/turtlecoin/node-cryptonote-util/blob/9cd8b14/typescript/index.ts#L41">index.ts:41</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Converts a block into a v1 hashing block typically used by miners during mining operations. This method actually creates a merged mining block that merge mines itself</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>template: <span class="tsd-signature-type">Buffer</span></h5> <div class="tsd-comment tsd-typography"> <p>the block template blob</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="convert_blob_bb" class="tsd-anchor"></a> <h3>convert_<wbr>blob_<wbr>bb</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">convert_<wbr>blob_<wbr>bb<span class="tsd-signature-symbol">(</span>template<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/turtlecoin/node-cryptonote-util/blob/9cd8b14/typescript/index.ts#L50">index.ts:50</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Legacy convert block (prior to merged mining) that parses and validates a block blob from a block template</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>template: <span class="tsd-signature-type">Buffer</span></h5> <div class="tsd-comment tsd-typography"> <p>the block template blob</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="get_block_id" class="tsd-anchor"></a> <h3>get_<wbr>block_<wbr>id</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">get_<wbr>block_<wbr>id<span class="tsd-signature-symbol">(</span>blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/turtlecoin/node-cryptonote-util/blob/9cd8b14/typescript/index.ts#L58">index.ts:58</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Calculates the block id (hash) of the given blob</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>blob: <span class="tsd-signature-type">Buffer</span></h5> <div class="tsd-comment tsd-typography"> <p>the block blob</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</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 current "> <a href="globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="classes/cryptonoteutils.html" class="tsd-kind-icon">Crypto<wbr>Note<wbr>Utils</a> </li> <li class=" tsd-kind-function"> <a href="globals.html#address_decode" class="tsd-kind-icon">address_<wbr>decode</a> </li> <li class=" tsd-kind-function"> <a href="globals.html#construct_block_blob" class="tsd-kind-icon">construct_<wbr>block_<wbr>blob</a> </li> <li class=" tsd-kind-function"> <a href="globals.html#convert_blob" class="tsd-kind-icon">convert_<wbr>blob</a> </li> <li class=" tsd-kind-function"> <a href="globals.html#convert_blob_bb" class="tsd-kind-icon">convert_<wbr>blob_<wbr>bb</a> </li> <li class=" tsd-kind-function"> <a href="globals.html#get_block_id" class="tsd-kind-icon">get_<wbr>block_<wbr>id</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>