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

Finalize documentation on models.

Browse Source
This commit is contained in:
Spencer Ofwiti
2021-05-12 10:52:28 +03:00
parent ca985d7af7
commit 948a735baf
49 changed files with 1308 additions and 473 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
docs/compodoc/interfaces/Conversion.html
View File

@@ -144,6 +144,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Final transaction token information. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -173,6 +179,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Initial transaction token amount. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -202,6 +214,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Initial transaction token information. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -231,6 +249,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Final transaction token amount. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -260,6 +284,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Address of the initiator of the conversion. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -289,6 +319,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Conversion mining information. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -318,6 +354,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account information of the initiator of the conversion. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -327,56 +369,70 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { AccountDetails } from &#x27;@app/_models/account&#x27;;
/** BlocksBloom object interface */
interface BlocksBloom {
low: number;
blockFilter: string;
blocktxFilter: string;
alg: string;
filterRounds: number;
}
/** Conversion object interface */
interface Conversion {
/** Final transaction token information. */
destinationToken: TxToken;
/** Initial transaction token amount. */
fromValue: number;
/** Initial transaction token information. */
sourceToken: TxToken;
/** Final transaction token amount. */
toValue: number;
/** Address of the initiator of the conversion. */
trader: string;
/** Account information of the initiator of the conversion. */
user: AccountDetails;
/** Conversion mining information. */
tx: Tx;
}
/** Transaction object interface */
interface Transaction {
/** Address of the transaction sender. */
from: string;
/** Account information of the transaction sender. */
sender: AccountDetails;
/** Address of the transaction recipient. */
to: string;
/** Account information of the transaction recipient. */
recipient: AccountDetails;
/** Transaction token information. */
token: TxToken;
/** Transaction mining information. */
tx: Tx;
/** Amount of tokens transacted. */
value: number;
/** Type of transaction. */
type?: string;
}
/** Transaction data interface */
interface Tx {
/** Transaction block number. */
block: number;
/** Transaction mining status. */
success: boolean;
/** Time transaction was mined. */
timestamp: number;
/** Hash generated by transaction. */
txHash: string;
/** Index of transaction in block. */
txIndex: number;
}
/** Transaction token object interface */
interface TxToken {
/** Address of the deployed token contract. */
address: string;
/** Name of the token. */
name: string;
/** The unique token symbol. */
symbol: string;
}
/** @exports */
export { BlocksBloom, Conversion, Transaction, Tx, TxToken };
export { Conversion, Transaction, Tx, TxToken };
</code></pre>
</div>
</div>