grassrootseconomics/cic-staff-client
8
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity

Update docs.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

202
docs/compodoc/injectables/BlockSyncService.html
View File

@@ -93,16 +93,18 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Async</span>
<a href="#blockSync">blockSync</a>
</li>
<li>
<a href="#fetcher">fetcher</a>
</li>
<li>
<a href="#newConversionEvent">newConversionEvent</a>
<span class="modifier">Async</span>
<a href="#init">init</a>
</li>
<li>
<a href="#newTransferEvent">newTransferEvent</a>
<a href="#newEvent">newEvent</a>
</li>
<li>
<a href="#readyStateProcessor">readyStateProcessor</a>
@@ -129,12 +131,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>, registryService: <a href="../injectables/RegistryService.html">RegistryService</a>)</code>
<code>constructor(transactionService: <a href="../injectables/TransactionService.html">TransactionService</a>, loggingService: <a href="../injectables/LoggingService.html">LoggingService</a>)</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>
<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>
@@ -175,18 +177,6 @@
</td>
</tr>
<tr>
<td>registryService</td>
<td>
<code><a href="../injectables/RegistryService.html" target="_self" >RegistryService</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
@@ -208,6 +198,7 @@
<a name="blockSync"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
blockSync
</b>
<a href="#blockSync"><span class="icon ion-ios-link"></span></a>
@@ -216,15 +207,16 @@
</tr>
<tr>
<td class="col-md-4">
<code>blockSync(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>
<span class="modifier-icon icon ion-ios-reset"></span>
<code>blockSync(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="23"
class="link-to-prism">src/app/_services/block-sync.service.ts:23</a></div>
<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>
</td>
</tr>
@@ -295,7 +287,7 @@
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
<b>Returns : </b> <code>Promise&lt;void&gt;</code>
</div>
<div class="io-description">
@@ -327,8 +319,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="118"
class="link-to-prism">src/app/_services/block-sync.service.ts:118</a></div>
<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>
</td>
</tr>
@@ -391,26 +383,67 @@
<tbody>
<tr>
<td class="col-md-4">
<a name="newConversionEvent"></a>
<a name="init"></a>
<span class="name">
<b>
newConversionEvent
<span class="modifier">Async</span>
init
</b>
<a href="#newConversionEvent"><span class="icon ion-ios-link"></span></a>
<a href="#init"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>newConversionEvent(tx: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
<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="89"
class="link-to-prism">src/app/_services/block-sync.service.ts:89</a></div>
<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>
<a href="#newEvent"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>newEvent(tx: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, eventType: <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">
<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>
</td>
</tr>
@@ -441,68 +474,10 @@
</tr>
</tbody>
</table>
</div>
<div>
</div>
<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>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="newTransferEvent"></a>
<span class="name">
<b>
newTransferEvent
</b>
<a href="#newTransferEvent"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>newTransferEvent(tx: <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="81"
class="link-to-prism">src/app/_services/block-sync.service.ts:81</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>tx</td>
<td>eventType</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
@@ -549,8 +524,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="46"
class="link-to-prism">src/app/_services/block-sync.service.ts:46</a></div>
<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>
</td>
</tr>
@@ -669,8 +644,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="97"
class="link-to-prism">src/app/_services/block-sync.service.ts:97</a></div>
<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>
</td>
</tr>
@@ -808,7 +783,7 @@
</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>
<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>
@@ -840,7 +815,7 @@
</tr>
<tr>
<td class="col-md-4">
<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>
<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>
@@ -855,12 +830,13 @@
<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 { Settings } from &#x27;@app/_models&#x27;;
import { TransactionHelper } from &#x27;cic-client&#x27;;
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;;
@Injectable({
providedIn: &#x27;root&#x27;,
@@ -871,31 +847,29 @@ export class BlockSyncService {
constructor(
private transactionService: TransactionService,
private loggingService: LoggingService,
private registryService: RegistryService
private loggingService: LoggingService
) {}
blockSync(address: string &#x3D; null, offset: number &#x3D; 0, limit: number &#x3D; 100): void {
async init(): Promise&lt;void&gt; {
await this.transactionService.init();
}
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;
settings.w3.engine &#x3D; this.registryService.getWeb3();
settings.registry &#x3D; this.registryService.getRegistry();
settings.w3.engine &#x3D; Web3Service.getInstance();
settings.registry &#x3D; await RegistryService.getRegistry();
settings.txHelper &#x3D; new TransactionHelper(settings.w3.engine, settings.registry);
settings.txHelper.ontransfer &#x3D; async (transaction: any): Promise&lt;void&gt; &#x3D;&gt; {
window.dispatchEvent(this.newTransferEvent(transaction));
window.dispatchEvent(this.newEvent(transaction, &#x27;cic_transfer&#x27;));
};
settings.txHelper.onconversion &#x3D; async (transaction: any): Promise&lt;any&gt; &#x3D;&gt; {
window.dispatchEvent(this.newConversionEvent(transaction));
window.dispatchEvent(this.newEvent(transaction, &#x27;cic_convert&#x27;));
};
settings.registry.onload &#x3D; (addressReturned: number): void &#x3D;&gt; {
this.loggingService.sendInfoLevelMessage(&#x60;Loaded network contracts ${addressReturned}&#x60;);
this.readyStateProcessor(settings, readyStateElements.network, address, offset, limit);
};
settings.registry.load();
this.readyStateProcessor(settings, readyStateElements.network, address, offset, limit);
}
readyStateProcessor(
@@ -933,16 +907,8 @@ export class BlockSyncService {
}
}
newTransferEvent(tx: any): any {
return new CustomEvent(&#x27;cic_transfer&#x27;, {
detail: {
tx,
},
});
}
newConversionEvent(tx: any): any {
return new CustomEvent(&#x27;cic_convert&#x27;, {
newEvent(tx: any, eventType: string): any {
return new CustomEvent(eventType, {
detail: {
tx,
},