Update docs.

This commit is contained in:
Spencer Ofwiti
2021-06-14 14:28:53 +03:00
parent 7923c63aa8
commit 4ed3d108cb
94 changed files with 10372 additions and 2785 deletions

View File

@@ -75,14 +75,14 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Static</span>
<a href="#fileGetter">fileGetter</a>
</li>
<li>
<span class="modifier">Private</span>
<span class="modifier">Static</span>
<a href="#registry">registry</a>
</li>
<li>
<a href="#web3">web3</a>
</li>
</ul>
</td>
</tr>
@@ -96,11 +96,10 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Static</span>
<span class="modifier">Async</span>
<a href="#getRegistry">getRegistry</a>
</li>
<li>
<a href="#getWeb3">getWeb3</a>
</li>
</ul>
</td>
</tr>
@@ -124,7 +123,7 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="19" class="link-to-prism">src/app/_services/registry.service.ts:19</a></div>
<div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">src/app/_services/registry.service.ts:12</a></div>
</td>
</tr>
@@ -144,6 +143,8 @@
<a name="getRegistry"></a>
<span class="name">
<b>
<span class="modifier">Static</span>
<span class="modifier">Async</span>
getRegistry
</b>
<a href="#getRegistry"><span class="icon ion-ios-link"></span></a>
@@ -152,15 +153,16 @@
</tr>
<tr>
<td class="col-md-4">
<code>getRegistry()</code>
<span class="modifier-icon icon ion-ios-reset"></span>
<code>getRegistry()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="26"
class="link-to-prism">src/app/_services/registry.service.ts:26</a></div>
<div class="io-line">Defined in <a href="" data-line="16"
class="link-to-prism">src/app/_services/registry.service.ts:16</a></div>
</td>
</tr>
@@ -169,46 +171,7 @@
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getWeb3"></a>
<span class="name">
<b>
getWeb3
</b>
<a href="#getWeb3"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getWeb3()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="30"
class="link-to-prism">src/app/_services/registry.service.ts:30</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
<b>Returns : </b> <code>Promise&lt;CICRegistry&gt;</code>
</div>
</td>
@@ -228,6 +191,7 @@
<a name="fileGetter"></a>
<span class="name">
<b>
<span class="modifier">Static</span>
fileGetter</b>
<a href="#fileGetter"><span class="icon ion-ios-link"></span></a>
</span>
@@ -246,7 +210,7 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">src/app/_services/registry.service.ts:12</a></div>
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/_services/registry.service.ts:11</a></div>
</td>
</tr>
@@ -260,6 +224,8 @@
<a name="registry"></a>
<span class="name">
<b>
<span class="modifier">Private</span>
<span class="modifier">Static</span>
registry</b>
<a href="#registry"><span class="icon ion-ios-link"></span></a>
</span>
@@ -271,52 +237,9 @@
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new CICRegistry(
this.web3,
environment.registryAddress,
&#x27;Registry&#x27;,
this.fileGetter,
[&#x27;../../assets/js/block-sync/data&#x27;]
)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="13" class="link-to-prism">src/app/_services/registry.service.ts:13</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="web3"></a>
<span class="name">
<b>
web3</b>
<a href="#web3"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Web3</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new Web3(environment.web3Provider)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/_services/registry.service.ts:11</a></div>
<div class="io-line">Defined in <a href="" data-line="12" class="link-to-prism">src/app/_services/registry.service.ts:12</a></div>
</td>
</tr>
@@ -330,36 +253,33 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Injectable } from &#x27;@angular/core&#x27;;
import Web3 from &#x27;web3&#x27;;
import { environment } from &#x27;@src/environments/environment&#x27;;
import { CICRegistry, FileGetter } from &#x27;cic-client&#x27;;
import { CICRegistry, FileGetter } from &#x27;@cicnet/cic-client&#x27;;
import { HttpGetter } from &#x27;@app/_helpers&#x27;;
import { Web3Service } from &#x27;@app/_services/web3.service&#x27;;
@Injectable({
providedIn: &#x27;root&#x27;,
})
export class RegistryService {
web3: Web3 &#x3D; new Web3(environment.web3Provider);
fileGetter: FileGetter &#x3D; new HttpGetter();
registry: CICRegistry &#x3D; new CICRegistry(
this.web3,
environment.registryAddress,
&#x27;Registry&#x27;,
this.fileGetter,
[&#x27;../../assets/js/block-sync/data&#x27;]
);
static fileGetter: FileGetter &#x3D; new HttpGetter();
private static registry: CICRegistry;
constructor() {
this.registry.declaratorHelper.addTrust(environment.trustedDeclaratorAddress);
this.registry.load();
}
constructor() {}
getRegistry(): any {
return this.registry;
}
getWeb3(): any {
return this.web3;
public static async getRegistry(): Promise&lt;CICRegistry&gt; {
if (!RegistryService.registry) {
RegistryService.registry &#x3D; new CICRegistry(
Web3Service.getInstance(),
environment.registryAddress,
&#x27;Registry&#x27;,
RegistryService.fileGetter,
[&#x27;../../assets/js/block-sync/data&#x27;]
);
RegistryService.registry.declaratorHelper.addTrust(environment.trustedDeclaratorAddress);
await RegistryService.registry.load();
}
return RegistryService.registry;
}
}
</code></pre>