dn724/dncurrency-js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Marvin ROGER 2018-07-12 10:58:50 +02:00 • committed by Marvin ROGER
commit 17bbfa99e4
11 changed files with 72 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/enums/unit.html
View file

@ -1055,7 +1055,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">KNano<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;KNano&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L39">conversion.ts:39</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L39">conversion.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1070,7 +1070,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">MNano<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;MNano&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L41">conversion.ts:41</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L41">conversion.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1085,7 +1085,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">NANO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;NANO&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L37">conversion.ts:37</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L37">conversion.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1100,7 +1100,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">Nano<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;Nano&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L35">conversion.ts:35</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L35">conversion.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1115,7 +1115,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">hex<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;hex&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L27">conversion.ts:27</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L27">conversion.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1130,7 +1130,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">knano<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;knano&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L33">conversion.ts:33</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L33">conversion.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1145,7 +1145,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">nano<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;nano&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L31">conversion.ts:31</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L31">conversion.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1160,7 +1160,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;&quot;raw&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L29">conversion.ts:29</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L29">conversion.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

45
docs/index.html
View file

@ -1055,13 +1055,15 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/check.ts#L82">check.ts:82</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/check.ts#L94">check.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given address is valid.</p>
</div>
<p><strong>Note:</strong> it checks the format and the checksum of the address.
It does not check whether or not the address does exist on the network.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -1087,13 +1089,14 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/check.ts#L38">check.ts:38</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/check.ts#L40">check.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given amount is valid.</p>
</div>
<p><strong>Note:</strong> a valid amount means that it can be embedded into a block <code>balance</code>.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -1119,13 +1122,14 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/check.ts#L62">check.ts:62</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/check.ts#L68">check.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given hash is valid.</p>
</div>
<p><strong>Note:</strong> it only checks the format of the hash.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -1151,13 +1155,15 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/check.ts#L72">check.ts:72</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/check.ts#L81">check.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given public or secret key is valid.</p>
</div>
<p><strong>Note:</strong> it only checks the format of the key.
It does not check whether or not the key does exist on the network.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -1183,13 +1189,14 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/check.ts#L52">check.ts:52</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/check.ts#L56">check.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given seed is valid.</p>
</div>
<p><strong>Note:</strong> it only checks the format of the seed.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -1215,13 +1222,14 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/check.ts#L104">check.ts:104</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/check.ts#L120">check.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given signature is valid.</p>
</div>
<p><strong>Note:</strong> it only checks the format of the signature.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -1247,13 +1255,14 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/check.ts#L94">check.ts:94</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/check.ts#L108">check.ts:108</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given work is valid.</p>
</div>
<p><strong>Note:</strong> it only checks the format of the work, not its difficulty.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -1279,7 +1288,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/accelerated.ts#L55">accelerated.ts:55</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/accelerated.ts#L55">accelerated.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1318,7 +1327,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L59">conversion.ts:59</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L59">conversion.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1356,7 +1365,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/block.ts#L36">block.ts:36</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/block.ts#L36">block.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1396,7 +1405,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/keys.ts#L98">keys.ts:98</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/keys.ts#L98">keys.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1434,7 +1443,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/keys.ts#L66">keys.ts:66</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/keys.ts#L66">keys.ts:66</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1466,7 +1475,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/keys.ts#L40">keys.ts:40</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/keys.ts#L40">keys.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1504,7 +1513,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/keys.ts#L19">keys.ts:19</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/keys.ts#L19">keys.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1527,7 +1536,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/hash.ts#L39">hash.ts:39</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/hash.ts#L39">hash.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1559,7 +1568,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/signature.ts#L26">signature.ts:26</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/signature.ts#L26">signature.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1591,7 +1600,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/work.ts#L29">work.ts:29</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/work.ts#L29">work.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1623,7 +1632,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/signature.ts#L54">signature.ts:54</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/signature.ts#L54">signature.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

10
docs/interfaces/blockdata.html
View file

@ -1051,7 +1051,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/block.ts#L24">block.ts:24</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/block.ts#L24">block.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1066,7 +1066,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">link<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/block.ts#L26">block.ts:26</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/block.ts#L26">block.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1081,7 +1081,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">previous<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/block.ts#L20">block.ts:20</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/block.ts#L20">block.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1096,7 +1096,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">representative<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/block.ts#L22">block.ts:22</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/block.ts#L22">block.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1111,7 +1111,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">work<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/block.ts#L18">block.ts:18</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/block.ts#L18">block.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

4
docs/interfaces/computeworkparams.html
View file

@ -1039,7 +1039,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">worker<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/accelerated.ts#L44">accelerated.ts:44</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/accelerated.ts#L44">accelerated.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1054,7 +1054,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">worker<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/accelerated.ts#L42">accelerated.ts:42</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/accelerated.ts#L42">accelerated.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

4
docs/interfaces/convertparams.html
View file

@ -1039,7 +1039,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <a href="../enums/unit.html" class="tsd-signature-type">Unit</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L47">conversion.ts:47</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L47">conversion.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1054,7 +1054,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">to<span class="tsd-signature-symbol">:</span> <a href="../enums/unit.html" class="tsd-signature-type">Unit</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/conversion.ts#L49">conversion.ts:49</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/conversion.ts#L49">conversion.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

2
docs/interfaces/deriveaddressparams.html
View file

@ -1035,7 +1035,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">use<wbr>Nano<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/keys.ts#L88">keys.ts:88</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/keys.ts#L88">keys.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

10
docs/interfaces/hashblockparams.html
View file

@ -1051,7 +1051,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/hash.ts#L22">hash.ts:22</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/hash.ts#L22">hash.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1066,7 +1066,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/hash.ts#L28">hash.ts:28</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/hash.ts#L28">hash.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1081,7 +1081,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">link<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/hash.ts#L30">hash.ts:30</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/hash.ts#L30">hash.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1096,7 +1096,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">previous<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/hash.ts#L24">hash.ts:24</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/hash.ts#L24">hash.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1111,7 +1111,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">representative<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/hash.ts#L26">hash.ts:26</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/hash.ts#L26">hash.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

4
docs/interfaces/signblockparams.html
View file

@ -1039,7 +1039,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/signature.ts#L15">signature.ts:15</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/signature.ts#L15">signature.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1054,7 +1054,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">secret<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/signature.ts#L17">signature.ts:17</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/signature.ts#L17">signature.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

4
docs/interfaces/validateworkparams.html
View file

@ -1039,7 +1039,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">block<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/work.ts#L18">work.ts:18</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/work.ts#L18">work.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1054,7 +1054,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">work<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/work.ts#L20">work.ts:20</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/work.ts#L20">work.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

6
docs/interfaces/verifyblockparams.html
View file

@ -1043,7 +1043,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/signature.ts#L41">signature.ts:41</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/signature.ts#L41">signature.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1058,7 +1058,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/signature.ts#L45">signature.ts:45</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/signature.ts#L45">signature.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1073,7 +1073,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/d404f5a/src/signature.ts#L43">signature.ts:43</a></li>
<li>Defined in <a href="https://github.com/marvinroger/nanocurrency-js/blob/db8ffcd/src/signature.ts#L43">signature.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

16
src/check.ts
View file

@ -32,6 +32,8 @@ export function checkNumber(candidate: any) {
/**
* Check if the given amount is valid.
*
* **Note:** a valid amount means that it can be embedded into a block `balance`.
*
* @param amount - The amount to check
* @returns Valid
*/
@ -46,6 +48,8 @@ export function checkAmount(amount: string) {
/**
* Check if the given seed is valid.
*
* **Note:** it only checks the format of the seed.
*
* @param seed - The seed to check
* @returns Valid
*/
@ -56,6 +60,8 @@ export function checkSeed(seed: string) {
/**
* Check if the given hash is valid.
*
* **Note:** it only checks the format of the hash.
*
* @param hash - The hash to check
* @returns Valid
*/
@ -66,6 +72,9 @@ export function checkHash(hash: string) {
/**
* Check if the given public or secret key is valid.
*
* **Note:** it only checks the format of the key.
* It does not check whether or not the key does exist on the network.
*
* @param key - The key to check
* @returns Valid
*/
@ -76,6 +85,9 @@ export function checkKey(key: string) {
/**
* Check if the given address is valid.
*
* **Note:** it checks the format and the checksum of the address.
* It does not check whether or not the address does exist on the network.
*
* @param address - The address to check
* @returns Valid
*/
@ -88,7 +100,7 @@ export function checkAddress(address: string) {
/**
* Check if the given work is valid.
*
* **Note:** this only checks the format of the work, not its difficulty
* **Note:** it only checks the format of the work, not its difficulty.
*
* @param work - The work to check
* @returns Valid
@ -100,6 +112,8 @@ export function checkWork(work: string) {
/**
* Check if the given signature is valid.
*
* **Note:** it only checks the format of the signature.
*
* @param signature - The signature to check
* @returns Valid
*/