Documentation update.

This commit is contained in:
Spencer Ofwiti
2021-09-02 23:48:41 +00:00
parent 0567b9b729
commit 33a446cfa4
133 changed files with 13908 additions and 9806 deletions

View File

@@ -8,7 +8,8 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css" media="(prefers-color-scheme: dark)">
</head>
<body>
@@ -38,7 +39,7 @@
<ol class="breadcrumb">
<li>Injectables</li>
<li>BlockSyncService</li>
<li >BlockSyncService</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
@@ -62,6 +63,7 @@
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
@@ -75,10 +77,10 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#readyState">readyState</a>
<a href="#readyState" >readyState</a>
</li>
<li>
<a href="#readyStateTarget">readyStateTarget</a>
<a href="#readyStateTarget" >readyStateTarget</a>
</li>
</ul>
</td>
@@ -94,24 +96,20 @@
<ul class="index-list">
<li>
<span class="modifier">Async</span>
<a href="#blockSync">blockSync</a>
<a href="#blockSync" >blockSync</a>
</li>
<li>
<a href="#fetcher">fetcher</a>
<a href="#fetcher" >fetcher</a>
</li>
<li>
<a href="#newEvent" >newEvent</a>
</li>
<li>
<a href="#readyStateProcessor" >readyStateProcessor</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#init">init</a>
</li>
<li>
<a href="#newEvent">newEvent</a>
</li>
<li>
<a href="#readyStateProcessor">readyStateProcessor</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#scan">scan</a>
<a href="#scan" >scan</a>
</li>
</ul>
</td>
@@ -131,12 +129,12 @@
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(transactionService: <a href="../injectables/TransactionService.html">TransactionService</a>, loggingService: <a href="../injectables/LoggingService.html">LoggingService</a>)</code>
<code>constructor(transactionService: <a href="../injectables/TransactionService.html" target="_self">TransactionService</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">src/app/_services/block-sync.service.ts:16</a></div>
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/_services/block-sync.service.ts:15</a></div>
</td>
</tr>
@@ -165,18 +163,6 @@
</td>
</tr>
<tr>
<td>loggingService</td>
<td>
<code><a href="../injectables/LoggingService.html" target="_self" >LoggingService</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
@@ -197,10 +183,8 @@
<td class="col-md-4">
<a name="blockSync"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
blockSync
</b>
<span class="modifier">Async</span>
<span ><b>blockSync</b></span>
<a href="#blockSync"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -215,8 +199,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="27"
class="link-to-prism">src/app/_services/block-sync.service.ts:27</a></div>
<div class="io-line">Defined in <a href="" data-line="19"
class="link-to-prism">src/app/_services/block-sync.service.ts:19</a></div>
</td>
</tr>
@@ -303,24 +287,22 @@
<td class="col-md-4">
<a name="fetcher"></a>
<span class="name">
<b>
fetcher
</b>
<span ><b>fetcher</b></span>
<a href="#fetcher"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>fetcher(settings: <a href="../classes/Settings.html">Settings</a>, transactionsInfo: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
<code>fetcher(settings: <a href="../classes/Settings.html" target="_self">Settings</a>, transactionsInfo: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="109"
class="link-to-prism">src/app/_services/block-sync.service.ts:109</a></div>
<div class="io-line">Defined in <a href="" data-line="100"
class="link-to-prism">src/app/_services/block-sync.service.ts:100</a></div>
</td>
</tr>
@@ -379,56 +361,13 @@
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="init"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
init
</b>
<a href="#init"><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>init()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="23"
class="link-to-prism">src/app/_services/block-sync.service.ts:23</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code>Promise&lt;void&gt;</code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="newEvent"></a>
<span class="name">
<b>
newEvent
</b>
<span ><b>newEvent</b></span>
<a href="#newEvent"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -442,8 +381,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="80"
class="link-to-prism">src/app/_services/block-sync.service.ts:80</a></div>
<div class="io-line">Defined in <a href="" data-line="71"
class="link-to-prism">src/app/_services/block-sync.service.ts:71</a></div>
</td>
</tr>
@@ -508,24 +447,22 @@
<td class="col-md-4">
<a name="readyStateProcessor"></a>
<span class="name">
<b>
readyStateProcessor
</b>
<span ><b>readyStateProcessor</b></span>
<a href="#readyStateProcessor"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>readyStateProcessor(settings: <a href="../classes/Settings.html">Settings</a>, bit: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, address: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, offset: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, limit: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
<code>readyStateProcessor(settings: <a href="../classes/Settings.html" target="_self">Settings</a>, bit: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, address: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, offset: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, limit: <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">
<div class="io-line">Defined in <a href="" data-line="45"
class="link-to-prism">src/app/_services/block-sync.service.ts:45</a></div>
<div class="io-line">Defined in <a href="" data-line="36"
class="link-to-prism">src/app/_services/block-sync.service.ts:36</a></div>
</td>
</tr>
@@ -626,10 +563,8 @@
<td class="col-md-4">
<a name="scan"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
scan
</b>
<span class="modifier">Async</span>
<span ><b>scan</b></span>
<a href="#scan"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -637,15 +572,15 @@
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>scan(settings: <a href="../classes/Settings.html">Settings</a>, lo: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, hi: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, bloomBlockBytes: Uint8Array, bloomBlocktxBytes: Uint8Array, bloomRounds: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
<code>scan(settings: <a href="../classes/Settings.html" target="_self">Settings</a>, lo: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, hi: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>, bloomBlockBytes: Uint8Array, bloomBlocktxBytes: Uint8Array, bloomRounds: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="88"
class="link-to-prism">src/app/_services/block-sync.service.ts:88</a></div>
<div class="io-line">Defined in <a href="" data-line="79"
class="link-to-prism">src/app/_services/block-sync.service.ts:79</a></div>
</td>
</tr>
@@ -755,73 +690,71 @@
</section>
<section>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="readyState"></a>
<span class="name">
<span ><b>readyState</b></span>
<a href="#readyState"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="readyState"></a>
<span class="name">
<b>
readyState</b>
<a href="#readyState"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code><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">
<i>Default value : </i><code>0</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/_services/block-sync.service.ts:15</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>0</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="16" class="link-to-prism">src/app/_services/block-sync.service.ts:16</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="readyStateTarget"></a>
<span class="name">
<span ><b>readyStateTarget</b></span>
<a href="#readyStateTarget"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="readyStateTarget"></a>
<span class="name">
<b>
readyStateTarget</b>
<a href="#readyStateTarget"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code><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">
<i>Default value : </i><code>2</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
<div class="io-line">Defined in <a href="" data-line="14" class="link-to-prism">src/app/_services/block-sync.service.ts:14</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>2</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/_services/block-sync.service.ts:15</a></div>
</td>
</tr>
</tbody>
</table>
</tbody>
</table>
</section>
</div>
@@ -834,7 +767,6 @@ import { TransactionHelper } from &#x27;@cicnet/cic-client&#x27;;
import { first } from &#x27;rxjs/operators&#x27;;
import { TransactionService } from &#x27;@app/_services/transaction.service&#x27;;
import { environment } from &#x27;@src/environments/environment&#x27;;
import { LoggingService } from &#x27;@app/_services/logging.service&#x27;;
import { RegistryService } from &#x27;@app/_services/registry.service&#x27;;
import { Web3Service } from &#x27;@app/_services/web3.service&#x27;;
@@ -845,17 +777,9 @@ export class BlockSyncService {
readyStateTarget: number &#x3D; 2;
readyState: number &#x3D; 0;
constructor(
private transactionService: TransactionService,
private loggingService: LoggingService
) {}
async init(): Promise&lt;void&gt; {
await this.transactionService.init();
}
constructor(private transactionService: TransactionService) {}
async blockSync(address: string &#x3D; null, offset: number &#x3D; 0, limit: number &#x3D; 100): Promise&lt;void&gt; {
this.transactionService.resetTransactionsList();
const settings: Settings &#x3D; new Settings(this.scan);
const readyStateElements: { network: number } &#x3D; { network: 2 };
settings.w3.provider &#x3D; environment.web3Provider;
@@ -994,9 +918,9 @@ export class BlockSyncService {
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.js" defer></script>
<script type="module" src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>