grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
af4342e076
cic-staff-client/docs/compodoc/classes/TokenRegistry.html

720 lines
27 KiB
HTML
Raw Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
Documentation update.
2021-09-03 01:48:41 +02:00
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
Add docs.
2021-05-10 20:56:20 +02:00
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">
<ol class="breadcrumb">
<li>Classes</li>
Documentation update.
2021-09-03 01:48:41 +02:00
<li >TokenRegistry</li>
Add docs.
2021-05-10 20:56:20 +02:00
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/_eth/token-registry.ts</code>
</p>
Documentation update.
2021-09-03 01:48:41 +02:00
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Provides an instance of the token registry contract.
Allows querying of tokens that have been registered as valid tokens in the network.</p>
Documentation update.
2021-09-03 01:48:41 +02:00
<p>This is our interface to the token registry contract.</p>
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
</p>
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
Add docs.
2021-05-10 20:56:20 +02:00
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#contract" >contract</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#contractAddress" >contractAddress</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#signerAddress" >signerAddress</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<span class="modifier">Async</span>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#addressOf" >addressOf</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Async</span>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#entry" >entry</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Async</span>
Documentation update.
2021-09-03 01:48:41 +02:00
<a href="#totalTokens" >totalTokens</a>
Add docs.
2021-05-10 20:56:20 +02:00
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(contractAddress: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, signerAddress?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<div class="io-line">Defined in <a href="" data-line="26" class="link-to-prism">src/app/_eth/token-registry.ts:26</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<div class="io-description"><p>Create a connection to the deployed token registry contract.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>contractAddress</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<td>
<code><ul>
<li>The deployed token registry contract&#39;s address.</li>
</ul>
</code>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
<tr>
<td>signerAddress</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
Yes
</td>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<td>
<code><ul>
<li>The account address of the account that deployed the token registry contract.</li>
</ul>
</code>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
Documentation update.
2021-09-03 01:48:41 +02:00
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="contract"></a>
<span class="name">
<span ><b>contract</b></span>
<a href="#contract"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="22" class="link-to-prism">src/app/_eth/token-registry.ts:22</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Documentation update.
2021-09-03 01:48:41 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>The instance of the token registry contract.</p>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
</div>
Documentation update.
2021-09-03 01:48:41 +02:00
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
Documentation update.
2021-09-03 01:48:41 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="contractAddress"></a>
<span class="name">
<span ><b>contractAddress</b></span>
<a href="#contractAddress"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="24" class="link-to-prism">src/app/_eth/token-registry.ts:24</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Documentation update.
2021-09-03 01:48:41 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>The deployed token registry contract&#39;s address.</p>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
</div>
Documentation update.
2021-09-03 01:48:41 +02:00
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
Documentation update.
2021-09-03 01:48:41 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="signerAddress"></a>
<span class="name">
<span ><b>signerAddress</b></span>
<a href="#signerAddress"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Documentation update.
2021-09-03 01:48:41 +02:00
<div class="io-line">Defined in <a href="" data-line="26" class="link-to-prism">src/app/_eth/token-registry.ts:26</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Documentation update.
2021-09-03 01:48:41 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>The account address of the account that deployed the token registry contract.</p>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
</div>
Documentation update.
2021-09-03 01:48:41 +02:00
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
Documentation update.
2021-09-03 01:48:41 +02:00
</tbody>
</table>
Add docs.
2021-05-10 20:56:20 +02:00
</section>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="addressOf"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span class="modifier">Public</span>
<span class="modifier">Async</span>
<span ><b>addressOf</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#addressOf"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>addressOf(identifier: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<div class="io-line">Defined in <a href="" data-line="57"
class="link-to-prism">src/app/_eth/token-registry.ts:57</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<div class="io-description"><p>Returns the address of the token with a given identifier.</p>
Documentation update.
2021-09-03 01:48:41 +02:00
<p>Prints the address of the token with the identifier &#39;sarafu&#39;:</p>
<div><pre class="line-numbers"><code class="language-typescript">console.log(await addressOf(&#39;sarafu&#39;));</code></pre></div></div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>identifier</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<td>
<ul>
<li>The name or identifier of the token to be fetched from the token registry.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<b>Example :</b>
<div>
<pre class="line-numbers"><code class="language-html">Prints the address of the token with the identifier &amp;#39;sarafu&amp;#39;:&lt;/p&gt;
Documentation update.
2021-09-03 01:48:41 +02:00
&lt;pre&gt;&lt;code class=&quot;language-typescript&quot;&gt;console.log(await addressOf(&amp;#39;sarafu&amp;#39;));
&lt;/code&gt;&lt;/pre&gt;</code></pre>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
</div>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
<div class="io-description">
<b>Returns : </b> <code>Promise&lt;string&gt;</code>
</div>
<div class="io-description">
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<p>The address of the token assigned the specified identifier in the token registry.</p>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="entry"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span class="modifier">Public</span>
<span class="modifier">Async</span>
<span ><b>entry</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#entry"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>entry(serial: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<div class="io-line">Defined in <a href="" data-line="75"
class="link-to-prism">src/app/_eth/token-registry.ts:75</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<div class="io-description"><p>Returns the address of a token with the given serial in the token registry.</p>
Documentation update.
2021-09-03 01:48:41 +02:00
<p>Prints the address of the token with the serial &#39;2&#39;:</p>
<div><pre class="line-numbers"><code class="language-typescript">console.log(await entry(2));</code></pre></div></div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>serial</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
<td>
No
</td>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<td>
<ul>
<li>The serial number of the token to be fetched.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<b>Example :</b>
<div>
<pre class="line-numbers"><code class="language-html">Prints the address of the token with the serial &amp;#39;2&amp;#39;:&lt;/p&gt;
Documentation update.
2021-09-03 01:48:41 +02:00
&lt;pre&gt;&lt;code class=&quot;language-typescript&quot;&gt;console.log(await entry(2));
&lt;/code&gt;&lt;/pre&gt;</code></pre>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
</div>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
<div class="io-description">
<b>Returns : </b> <code>Promise&lt;string&gt;</code>
</div>
<div class="io-description">
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<p>The address of the token with the specified serial number.</p>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="totalTokens"></a>
<span class="name">
Documentation update.
2021-09-03 01:48:41 +02:00
<span class="modifier">Public</span>
<span class="modifier">Async</span>
<span ><b>totalTokens</b></span>
Add docs.
2021-05-10 20:56:20 +02:00
<a href="#totalTokens"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>totalTokens()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Update docs.
2021-06-14 13:28:53 +02:00
<div class="io-line">Defined in <a href="" data-line="91"
class="link-to-prism">src/app/_eth/token-registry.ts:91</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<div class="io-description"><p>Returns the total number of tokens that have been registered in the network.</p>
Documentation update.
2021-09-03 01:48:41 +02:00
<p>Prints the total number of registered tokens:</p>
<div><pre class="line-numbers"><code class="language-typescript">console.log(await totalTokens());</code></pre></div></div>
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<div>
<b>Example :</b>
<div>
<pre class="line-numbers"><code class="language-html">Prints the total number of registered tokens:&lt;/p&gt;
Documentation update.
2021-09-03 01:48:41 +02:00
&lt;pre&gt;&lt;code class=&quot;language-typescript&quot;&gt;console.log(await totalTokens());
&lt;/code&gt;&lt;/pre&gt;</code></pre>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
</div>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Returns : </b> <code>Promise&lt;number&gt;</code>
</div>
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
<div class="io-description">
<p>The total number of registered tokens.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import Web3 from &#x27;web3&#x27;;
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
// Application imports
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
import { environment } from &#x27;@src/environments/environment&#x27;;
Update docs.
2021-06-14 13:28:53 +02:00
import { Web3Service } from &#x27;@app/_services/web3.service&#x27;;
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/** Fetch the token registry contract&#x27;s ABI. */
Add docs.
2021-05-10 20:56:20 +02:00
const abi: Array&lt;any&gt; &#x3D; require(&#x27;@src/assets/js/block-sync/data/TokenUniqueSymbolIndex.json&#x27;);
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/** Establish a connection to the blockchain network. */
Update docs.
2021-06-14 13:28:53 +02:00
const web3: Web3 &#x3D; Web3Service.getInstance();
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/**
* Provides an instance of the token registry contract.
* Allows querying of tokens that have been registered as valid tokens in the network.
*
* @remarks
* This is our interface to the token registry contract.
*/
Add docs.
2021-05-10 20:56:20 +02:00
export class TokenRegistry {
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/** The instance of the token registry contract. */
contract: any;
/** The deployed token registry contract&#x27;s address. */
Add docs.
2021-05-10 20:56:20 +02:00
contractAddress: string;
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/** The account address of the account that deployed the token registry contract. */
Add docs.
2021-05-10 20:56:20 +02:00
signerAddress: string;
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/**
* Create a connection to the deployed token registry contract.
*
* @param contractAddress - The deployed token registry contract&#x27;s address.
* @param signerAddress - The account address of the account that deployed the token registry contract.
*/
Add docs.
2021-05-10 20:56:20 +02:00
constructor(contractAddress: string, signerAddress?: string) {
this.contractAddress &#x3D; contractAddress;
this.contract &#x3D; new web3.eth.Contract(abi, this.contractAddress);
if (signerAddress) {
this.signerAddress &#x3D; signerAddress;
} else {
this.signerAddress &#x3D; web3.eth.accounts[0];
}
}
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/**
* Returns the address of the token with a given identifier.
*
* @async
* @example
* Prints the address of the token with the identifier &#x27;sarafu&#x27;:
* &#x60;&#x60;&#x60;typescript
* console.log(await addressOf(&#x27;sarafu&#x27;));
* &#x60;&#x60;&#x60;
*
* @param identifier - The name or identifier of the token to be fetched from the token registry.
* @returns The address of the token assigned the specified identifier in the token registry.
*/
public async addressOf(identifier: string): Promise&lt;string&gt; {
const id: string &#x3D; web3.eth.abi.encodeParameter(&#x27;bytes32&#x27;, web3.utils.toHex(identifier));
return await this.contract.methods.addressOf(id).call();
Add docs.
2021-05-10 20:56:20 +02:00
}
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/**
* Returns the address of a token with the given serial in the token registry.
*
* @async
* @example
* Prints the address of the token with the serial &#x27;2&#x27;:
* &#x60;&#x60;&#x60;typescript
* console.log(await entry(2));
* &#x60;&#x60;&#x60;
*
* @param serial - The serial number of the token to be fetched.
* @return The address of the token with the specified serial number.
*/
Add docs.
2021-05-10 20:56:20 +02:00
public async entry(serial: number): Promise&lt;string&gt; {
return await this.contract.methods.entry(serial).call();
}
Add documentation to eth modules.
2021-05-11 11:05:04 +02:00
/**
* Returns the total number of tokens that have been registered in the network.
*
* @async
* @example
* Prints the total number of registered tokens:
* &#x60;&#x60;&#x60;typescript
* console.log(await totalTokens());
* &#x60;&#x60;&#x60;
*
* @returns The total number of registered tokens.
*/
public async totalTokens(): Promise&lt;number&gt; {
return await this.contract.methods.entryCount().call();
Add docs.
2021-05-10 20:56:20 +02:00
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'TokenRegistry.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
Documentation update.
2021-09-03 01:48:41 +02:00
<script type="module" src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
Add docs.
2021-05-10 20:56:20 +02:00
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink