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>TransactionService</li>
<li >TransactionService</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,23 +77,20 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#registry">registry</a>
<a href="#registry" >registry</a>
</li>
<li>
<span class="modifier">Private</span>
<a href="#transactionList">transactionList</a>
<a href="#transactionList" >transactionList</a>
</li>
<li>
<a href="#transactions">transactions</a>
<a href="#transactions" >transactions</a>
</li>
<li>
<a href="#transactionsSubject">transactionsSubject</a>
<a href="#transactionsSubject" >transactionsSubject</a>
</li>
<li>
<a href="#userInfo">userInfo</a>
</li>
<li>
<a href="#web3">web3</a>
<a href="#web3" >web3</a>
</li>
</ul>
</td>
@@ -106,35 +105,35 @@
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#addTransaction">addTransaction</a>
<a href="#addTransaction" >addTransaction</a>
</li>
<li>
<a href="#getAccountInfo">getAccountInfo</a>
<a href="#getAccountInfo" >getAccountInfo</a>
</li>
<li>
<a href="#getAddressTransactions">getAddressTransactions</a>
<a href="#getAddressTransactions" >getAddressTransactions</a>
</li>
<li>
<a href="#getAllTransactions">getAllTransactions</a>
<a href="#getAllTransactions" >getAllTransactions</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#init">init</a>
<a href="#init" >init</a>
</li>
<li>
<a href="#resetTransactionsList">resetTransactionsList</a>
<a href="#resetTransactionsList" >resetTransactionsList</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#setConversion">setConversion</a>
<a href="#setConversion" >setConversion</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#setTransaction">setTransaction</a>
<a href="#setTransaction" >setTransaction</a>
</li>
<li>
<span class="modifier">Async</span>
<a href="#transferRequest">transferRequest</a>
<a href="#transferRequest" >transferRequest</a>
</li>
</ul>
</td>
@@ -154,12 +153,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>)</code>
<code>constructor(httpClient: <a href="https://angular.io/api/common/http/HttpClient" target="_blank">HttpClient</a>, userService: <a href="../injectables/UserService.html" target="_self">UserService</a>, loggingService: <a href="../injectables/LoggingService.html" target="_self">LoggingService</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">src/app/_services/transaction.service.ts:33</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>
@@ -187,18 +186,6 @@
No
</td>
</tr>
<tr>
<td>authService</td>
<td>
<code><a href="../injectables/AuthService.html" target="_self" >AuthService</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>userService</td>
@@ -244,9 +231,7 @@
<td class="col-md-4">
<a name="addTransaction"></a>
<span class="name">
<b>
addTransaction
</b>
<span ><b>addTransaction</b></span>
<a href="#addTransaction"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -260,8 +245,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="143"
class="link-to-prism">src/app/_services/transaction.service.ts:143</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>
@@ -325,9 +310,7 @@
<td class="col-md-4">
<a name="getAccountInfo"></a>
<span class="name">
<b>
getAccountInfo
</b>
<span ><b>getAccountInfo</b></span>
<a href="#getAccountInfo"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -341,8 +324,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="163"
class="link-to-prism">src/app/_services/transaction.service.ts:163</a></div>
<div class="io-line">Defined in <a href="" data-line="158"
class="link-to-prism">src/app/_services/transaction.service.ts:158</a></div>
</td>
</tr>
@@ -413,9 +396,7 @@
<td class="col-md-4">
<a name="getAddressTransactions"></a>
<span class="name">
<b>
getAddressTransactions
</b>
<span ><b>getAddressTransactions</b></span>
<a href="#getAddressTransactions"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -429,8 +410,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="54"
class="link-to-prism">src/app/_services/transaction.service.ts:54</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>
@@ -507,9 +488,7 @@
<td class="col-md-4">
<a name="getAllTransactions"></a>
<span class="name">
<b>
getAllTransactions
</b>
<span ><b>getAllTransactions</b></span>
<a href="#getAllTransactions"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -523,8 +502,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="50"
class="link-to-prism">src/app/_services/transaction.service.ts:50</a></div>
<div class="io-line">Defined in <a href="" data-line="45"
class="link-to-prism">src/app/_services/transaction.service.ts:45</a></div>
</td>
</tr>
@@ -589,10 +568,8 @@
<td class="col-md-4">
<a name="init"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
init
</b>
<span class="modifier">Async</span>
<span ><b>init</b></span>
<a href="#init"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -607,8 +584,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="44"
class="link-to-prism">src/app/_services/transaction.service.ts:44</a></div>
<div class="io-line">Defined in <a href="" data-line="41"
class="link-to-prism">src/app/_services/transaction.service.ts:41</a></div>
</td>
</tr>
@@ -630,9 +607,7 @@
<td class="col-md-4">
<a name="resetTransactionsList"></a>
<span class="name">
<b>
resetTransactionsList
</b>
<span ><b>resetTransactionsList</b></span>
<a href="#resetTransactionsList"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -646,8 +621,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="158"
class="link-to-prism">src/app/_services/transaction.service.ts:158</a></div>
<div class="io-line">Defined in <a href="" data-line="153"
class="link-to-prism">src/app/_services/transaction.service.ts:153</a></div>
</td>
</tr>
@@ -669,10 +644,8 @@
<td class="col-md-4">
<a name="setConversion"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
setConversion
</b>
<span class="modifier">Async</span>
<span ><b>setConversion</b></span>
<a href="#setConversion"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -687,8 +660,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="110"
class="link-to-prism">src/app/_services/transaction.service.ts:110</a></div>
<div class="io-line">Defined in <a href="" data-line="105"
class="link-to-prism">src/app/_services/transaction.service.ts:105</a></div>
</td>
</tr>
@@ -746,10 +719,8 @@
<td class="col-md-4">
<a name="setTransaction"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
setTransaction
</b>
<span class="modifier">Async</span>
<span ><b>setTransaction</b></span>
<a href="#setTransaction"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -764,8 +735,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="58"
class="link-to-prism">src/app/_services/transaction.service.ts:58</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>
@@ -829,10 +800,8 @@
<td class="col-md-4">
<a name="transferRequest"></a>
<span class="name">
<b>
<span class="modifier">Async</span>
transferRequest
</b>
<span class="modifier">Async</span>
<span ><b>transferRequest</b></span>
<a href="#transferRequest"><span class="icon ion-ios-link"></span></a>
</span>
</td>
@@ -847,8 +816,8 @@
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="170"
class="link-to-prism">src/app/_services/transaction.service.ts:170</a></div>
<div class="io-line">Defined in <a href="" data-line="165"
class="link-to-prism">src/app/_services/transaction.service.ts:165</a></div>
</td>
</tr>
@@ -934,175 +903,143 @@
</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="registry"></a>
<span class="name">
<span ><b>registry</b></span>
<a href="#registry"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="registry"></a>
<span class="name">
<b>
registry</b>
<a href="#registry"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code>CICRegistry</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>CICRegistry</code>
<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>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">src/app/_services/transaction.service.ts:33</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="transactionList"></a>
<span class="name">
<span class="modifier">Private</span>
<span ><b>transactionList</b></span>
<a href="#transactionList"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="transactionList"></a>
<span class="name">
<b>
<span class="modifier">Private</span>
transactionList</b>
<a href="#transactionList"><span class="icon ion-ios-link"></span></a>
</span>
<i>Default value : </i><code>new BehaviorSubject&lt;any[]&gt;(this.transactions)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>new BehaviorSubject&lt;any[]&gt;(this.transactions)</code>
<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>
<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>
</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="transactions"></a>
<span class="name">
<span ><b>transactions</b></span>
<a href="#transactions"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="transactions"></a>
<span class="name">
<b>
transactions</b>
<a href="#transactions"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code>any[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>any[]</code>
<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>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>[]</code>
</td>
</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>
</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="transactionsSubject"></a>
<span class="name">
<span ><b>transactionsSubject</b></span>
<a href="#transactionsSubject"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="transactionsSubject"></a>
<span class="name">
<b>
transactionsSubject</b>
<a href="#transactionsSubject"><span class="icon ion-ios-link"></span></a>
</span>
<i>Default value : </i><code>this.transactionList.asObservable()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.transactionList.asObservable()</code>
<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>
<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>
</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="web3"></a>
<span class="name">
<span ><b>web3</b></span>
<a href="#web3"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<a name="userInfo"></a>
<span class="name">
<b>
userInfo</b>
<a href="#userInfo"><span class="icon ion-ios-link"></span></a>
</span>
<i>Type : </i> <code>Web3</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
<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>
<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>
</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">
<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>
</tbody>
</table>
</tbody>
</table>
</section>
</div>
@@ -1121,7 +1058,6 @@ import { add0x, fromHex, strip0x, toHex } from &#x27;@src/assets/js/ethtx/dist/h
import { Tx } from &#x27;@src/assets/js/ethtx/dist&#x27;;
import { toValue } from &#x27;@src/assets/js/ethtx/dist/tx&#x27;;
import * as secp256k1 from &#x27;secp256k1&#x27;;
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;;
@@ -1139,13 +1075,11 @@ export class TransactionService {
transactions: any[] &#x3D; [];
private transactionList &#x3D; new BehaviorSubject&lt;any[]&gt;(this.transactions);
transactionsSubject &#x3D; this.transactionList.asObservable();
userInfo: any;
web3: Web3;
registry: CICRegistry;
constructor(
private httpClient: HttpClient,
private authService: AuthService,
private userService: UserService,
private loggingService: LoggingService
) {
@@ -1153,8 +1087,6 @@ export class TransactionService {
}
async init(): Promise&lt;void&gt; {
await this.authService.init();
await this.userService.init();
this.registry &#x3D; await RegistryService.getRegistry();
}
@@ -1292,7 +1224,7 @@ export class TransactionService {
const hash &#x3D; hashFunction.digest();
const methodSignature &#x3D; hash.toString(&#x27;hex&#x27;).substring(0, 8);
const abiCoder &#x3D; new utils.AbiCoder();
const abi &#x3D; await abiCoder.encode(
const abi &#x3D; abiCoder.encode(
[&#x27;address&#x27;, &#x27;address&#x27;, &#x27;address&#x27;, &#x27;uint256&#x27;],
[senderAddress, recipientAddress, tokenAddress, value]
);
@@ -1362,9 +1294,9 @@ export class TransactionService {
<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>