turtlecoin-cryptonote-util
Version:
184 lines • 8.37 kB
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">
<div class="tsd-panel tsd-typography">
<p><img src="https://user-images.githubusercontent.com/34389545/35821974-62e0e25c-0a70-11e8-87dd-2cfffeb6ed47.png" alt="image"></p>
<a href="#master-build-status" id="master-build-status" style="color: inherit; text-decoration: none;">
<h4>Master Build Status</h4>
</a>
<p><a href="https://github.com/turtlecoin/node-cryptonote-util/actions"><img src="https://github.com/turtlecoin/node-cryptonote-util/workflows/CI%20Build%20Tests/badge.svg?branch=master" alt="Build Status"></a></p>
<a href="#development-build-status" id="development-build-status" style="color: inherit; text-decoration: none;">
<h4>Development Build Status</h4>
</a>
<p><a href="https://github.com/turtlecoin/node-cryptonote-util/actions"><img src="https://github.com/turtlecoin/node-cryptonote-util/workflows/CI%20Build%20Tests/badge.svg?branch=development" alt="Build Status"></a></p>
<p><a href="https://nodei.co/npm/turtlecoin-cryptonote-util/"><img src="https://nodei.co/npm/turtlecoin-cryptonote-util.png?downloads=true&stars=true" alt="NPM"></a></p>
<a href="#node-cryptonote-util" id="node-cryptonote-util" style="color: inherit; text-decoration: none;">
<h1>Node-Cryptonote-Util</h1>
</a>
<p><strong>Note:</strong> We build prebuilds of the Node.js native addon module binaries that are included for distribution with the NPM
installed version of this package to speed up your development and use of this package.</p>
<p>Supported on the following platforms:</p>
<ul>
<li>Linux 64-bit</li>
<li>Windows 64-bit</li>
</ul>
<a href="#dependencies" id="dependencies" style="color: inherit; text-decoration: none;">
<h2>Dependencies</h2>
</a>
<ul>
<li>Node.js LTS (<a href="https://nodejs.org/">https://nodejs.org/</a>) 10+</li>
<li>Boost (<a href="http://www.boost.org/">http://www.boost.org/</a>)</li>
</ul>
<a href="#windows-if-not-using-prebuilds" id="windows-if-not-using-prebuilds" style="color: inherit; text-decoration: none;">
<h4>Windows (if not using prebuilds)</h4>
</a>
<p>Read very careful if you want this to work right the first time.</p>
<ol>
<li><p>Open a <em>Windows Powershell</em> console as <strong>Administrator</strong></p>
</li>
<li><p>Run the command: <code>npm install -g windows-build-tools --vs2015</code>
<strong><em>This will take a while. Sit tight.</em></strong></p>
</li>
</ol>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h2>Installation</h2>
</a>
<pre><code class="language-bash">npm install turtlecoin-cryptonote-util</code></pre>
<a href="#intialization" id="intialization" style="color: inherit; text-decoration: none;">
<h3>Intialization</h3>
</a>
<a href="#typescript" id="typescript" style="color: inherit; text-decoration: none;">
<h4>TypeScript</h4>
</a>
<a href="#importing-individual-synchronous-methods" id="importing-individual-synchronous-methods" style="color: inherit; text-decoration: none;">
<h5>Importing Individual Synchronous Methods</h5>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">import</span> {
address_decode,
construct_block_blob,
convert_blob,
convert_blob_bb,
get_block_id
} <span class="hljs-keyword">from</span> <span class="hljs-string">'turtlecoin-cryptonote-util'</span>;</code></pre>
<a href="#importing-async-class" id="importing-async-class" style="color: inherit; text-decoration: none;">
<h5>Importing Async Class</h5>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">import</span> CryptoNoteUtils <span class="hljs-keyword">from</span> <span class="hljs-string">'turtlecoin-cryptonote-util'</span>;</code></pre>
<a href="#commonjs" id="commonjs" style="color: inherit; text-decoration: none;">
<h4>CommonJS</h4>
</a>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> cnUtils = <span class="hljs-built_in">require</span>(<span class="hljs-string">'turtlecoin-cryptonote-util'</span>);</code></pre>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h3>Documentation</h3>
</a>
<p>You can find the full TypeScript/JS documentation for this library <a href="https://cnutils.turtlecoin.dev">here</a>.</p>
</div>
</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>
</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>