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

@@ -117,6 +117,10 @@
<li>
<a href="#getAllTransactions">getAllTransactions</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#init">init</a>
</li>
<li>
<a href="#resetTransactionsList">resetTransactionsList</a>
</li>
@@ -150,12 +154,12 @@
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(httpClient: <a href="https://angular.io/api/common/http/HttpClient" target="_blank">HttpClient</a>, authService: <a href="../injectables/AuthService.html">AuthService</a>, userService: <a href="../injectables/UserService.html">UserService</a>, loggingService: <a href="../injectables/LoggingService.html">LoggingService</a>, registryService: <a href="../injectables/RegistryService.html">RegistryService</a>)</code>
<code>constructor(httpClient: <a href="https://angular.io/api/common/http/HttpClient" target="_blank">HttpClient</a>, authService: <a href="../injectables/AuthService.html">AuthService</a>, userService: <a href="../injectables/UserService.html">UserService</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="31" class="link-to-prism">src/app/_services/transaction.service.ts:31</a></div>
<div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">src/app/_services/transaction.service.ts:32</a></div>
</td>
</tr>
@@ -220,18 +224,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>
@@ -268,8 +260,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="111"
class="link-to-prism">src/app/_services/transaction.service.ts:111</a></div>
<div class="io-line">Defined in <a href="" data-line="118"
class="link-to-prism">src/app/_services/transaction.service.ts:118</a></div>
</td>
</tr>
@@ -342,15 +334,15 @@
</tr>
<tr>
<td class="col-md-4">
<code>getAccountInfo(account: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
<code>getAccountInfo(account: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, cacheSize: <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="124"
class="link-to-prism">src/app/_services/transaction.service.ts:124</a></div>
<div class="io-line">Defined in <a href="" data-line="138"
class="link-to-prism">src/app/_services/transaction.service.ts:138</a></div>
</td>
</tr>
@@ -366,6 +358,7 @@
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
@@ -379,6 +372,23 @@
No
</td>
<td>
</td>
</tr>
<tr>
<td>cacheSize</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>
<td>
<code>100</code>
</td>
</tr>
</tbody>
@@ -419,8 +429,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="49"
class="link-to-prism">src/app/_services/transaction.service.ts:49</a></div>
<div class="io-line">Defined in <a href="" data-line="53"
class="link-to-prism">src/app/_services/transaction.service.ts:53</a></div>
</td>
</tr>
@@ -513,8 +523,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="45"
class="link-to-prism">src/app/_services/transaction.service.ts:45</a></div>
<div class="io-line">Defined in <a href="" data-line="49"
class="link-to-prism">src/app/_services/transaction.service.ts:49</a></div>
</td>
</tr>
@@ -573,6 +583,47 @@
</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="43"
class="link-to-prism">src/app/_services/transaction.service.ts:43</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>
@@ -595,8 +646,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="119"
class="link-to-prism">src/app/_services/transaction.service.ts:119</a></div>
<div class="io-line">Defined in <a href="" data-line="133"
class="link-to-prism">src/app/_services/transaction.service.ts:133</a></div>
</td>
</tr>
@@ -636,8 +687,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="87"
class="link-to-prism">src/app/_services/transaction.service.ts:87</a></div>
<div class="io-line">Defined in <a href="" data-line="93"
class="link-to-prism">src/app/_services/transaction.service.ts:93</a></div>
</td>
</tr>
@@ -713,8 +764,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="53"
class="link-to-prism">src/app/_services/transaction.service.ts:53</a></div>
<div class="io-line">Defined in <a href="" data-line="57"
class="link-to-prism">src/app/_services/transaction.service.ts:57</a></div>
</td>
</tr>
@@ -796,8 +847,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="130"
class="link-to-prism">src/app/_services/transaction.service.ts:130</a></div>
<div class="io-line">Defined in <a href="" data-line="145"
class="link-to-prism">src/app/_services/transaction.service.ts:145</a></div>
</td>
</tr>
@@ -906,7 +957,7 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">src/app/_services/transaction.service.ts:31</a></div>
<div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">src/app/_services/transaction.service.ts:32</a></div>
</td>
</tr>
@@ -933,7 +984,7 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="27" class="link-to-prism">src/app/_services/transaction.service.ts:27</a></div>
<div class="io-line">Defined in <a href="" data-line="28" class="link-to-prism">src/app/_services/transaction.service.ts:28</a></div>
</td>
</tr>
@@ -965,7 +1016,7 @@
</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/transaction.service.ts:26</a></div>
<div class="io-line">Defined in <a href="" data-line="27" class="link-to-prism">src/app/_services/transaction.service.ts:27</a></div>
</td>
</tr>
@@ -991,7 +1042,7 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="28" class="link-to-prism">src/app/_services/transaction.service.ts:28</a></div>
<div class="io-line">Defined in <a href="" data-line="29" class="link-to-prism">src/app/_services/transaction.service.ts:29</a></div>
</td>
</tr>
@@ -1018,7 +1069,7 @@
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="29" class="link-to-prism">src/app/_services/transaction.service.ts:29</a></div>
<div class="io-line">Defined in <a href="" data-line="30" class="link-to-prism">src/app/_services/transaction.service.ts:30</a></div>
</td>
</tr>
@@ -1045,7 +1096,7 @@
</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/transaction.service.ts:30</a></div>
<div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">src/app/_services/transaction.service.ts:31</a></div>
</td>
</tr>
@@ -1074,9 +1125,10 @@ import { AuthService } from &#x27;@app/_services/auth.service&#x27;;
import { defaultAccount } from &#x27;@app/_models&#x27;;
import { LoggingService } from &#x27;@app/_services/logging.service&#x27;;
import { HttpClient } from &#x27;@angular/common/http&#x27;;
import { CICRegistry } from &#x27;cic-client&#x27;;
import { CICRegistry } from &#x27;@cicnet/cic-client&#x27;;
import { RegistryService } from &#x27;@app/_services/registry.service&#x27;;
import Web3 from &#x27;web3&#x27;;
import { Web3Service } from &#x27;@app/_services/web3.service&#x27;;
const vCard &#x3D; require(&#x27;vcard-parser&#x27;);
@Injectable({
@@ -1094,12 +1146,15 @@ export class TransactionService {
private httpClient: HttpClient,
private authService: AuthService,
private userService: UserService,
private loggingService: LoggingService,
private registryService: RegistryService
private loggingService: LoggingService
) {
this.web3 &#x3D; this.registryService.getWeb3();
this.registry &#x3D; registryService.getRegistry();
this.registry.load();
this.web3 &#x3D; Web3Service.getInstance();
}
async init(): Promise&lt;void&gt; {
await this.authService.init();
await this.userService.init();
this.registry &#x3D; await RegistryService.getRegistry();
}
getAllTransactions(offset: number, limit: number): Observable&lt;any&gt; {
@@ -1107,7 +1162,7 @@ export class TransactionService {
}
getAddressTransactions(address: string, offset: number, limit: number): Observable&lt;any&gt; {
return this.httpClient.get(&#x60;${environment.cicCacheUrl}/tx/${address}/${offset}/${limit}&#x60;);
return this.httpClient.get(&#x60;${environment.cicCacheUrl}/tx/user/${address}/${offset}/${limit}&#x60;);
}
async setTransaction(transaction, cacheSize: number): Promise&lt;void&gt; {
@@ -1122,10 +1177,11 @@ export class TransactionService {
.pipe(first())
.subscribe(
(res) &#x3D;&gt; {
transaction.sender &#x3D; this.getAccountInfo(res.body);
transaction.sender &#x3D; this.getAccountInfo(res, cacheSize);
},
(error) &#x3D;&gt; {
transaction.sender &#x3D; defaultAccount;
this.userService.addAccount(defaultAccount, cacheSize);
}
);
this.userService
@@ -1133,10 +1189,11 @@ export class TransactionService {
.pipe(first())
.subscribe(
(res) &#x3D;&gt; {
transaction.recipient &#x3D; this.getAccountInfo(res.body);
transaction.recipient &#x3D; this.getAccountInfo(res, cacheSize);
},
(error) &#x3D;&gt; {
transaction.recipient &#x3D; defaultAccount;
this.userService.addAccount(defaultAccount, cacheSize);
}
);
} finally {
@@ -1157,10 +1214,11 @@ export class TransactionService {
.pipe(first())
.subscribe(
(res) &#x3D;&gt; {
conversion.sender &#x3D; conversion.recipient &#x3D; this.getAccountInfo(res.body);
conversion.sender &#x3D; conversion.recipient &#x3D; this.getAccountInfo(res);
},
(error) &#x3D;&gt; {
conversion.sender &#x3D; conversion.recipient &#x3D; defaultAccount;
this.userService.addAccount(defaultAccount, cacheSize);
}
);
} finally {
@@ -1169,9 +1227,16 @@ export class TransactionService {
}
addTransaction(transaction, cacheSize: number): void {
const savedIndex &#x3D; this.transactions.findIndex((tx) &#x3D;&gt; tx.tx.txHash &#x3D;&#x3D;&#x3D; transaction.tx.txHash);
if (savedIndex &#x3D;&#x3D;&#x3D; 0) {
return;
}
if (savedIndex &gt; 0) {
this.transactions.splice(savedIndex, 1);
}
this.transactions.unshift(transaction);
if (this.transactions.length &gt; cacheSize) {
this.transactions.length &#x3D; cacheSize;
this.transactions.length &#x3D; Math.min(this.transactions.length, cacheSize);
}
this.transactionList.next(this.transactions);
}
@@ -1181,9 +1246,10 @@ export class TransactionService {
this.transactionList.next(this.transactions);
}
getAccountInfo(account: string): any {
getAccountInfo(account: string, cacheSize: number &#x3D; 100): any {
const accountInfo &#x3D; Envelope.fromJSON(JSON.stringify(account)).unwrap().m.data;
accountInfo.vcard &#x3D; vCard.parse(atob(accountInfo.vcard));
this.userService.addAccount(accountInfo, cacheSize);
return accountInfo;
}