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

79
docs/compodoc/interfaces/AccountDetails.html
View File

@@ -162,6 +162,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Age of user </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -196,6 +202,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Token balance on account </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -230,6 +242,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Business category of user. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -259,6 +277,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account registration day </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -288,6 +312,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>User&#39;s gender </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -317,6 +347,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account identifiers </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -346,6 +382,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>User&#39;s location </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -375,6 +417,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Products or services provided by user. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -409,6 +457,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Type of account </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -438,6 +492,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Personal identifying information of user </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -446,11 +506,17 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface AccountDetails {
/** Account registration day */
date_registered: number;
/** User&#x27;s gender */
gender: string;
/** Age of user */
age?: string;
/** Type of account */
type?: string;
/** Token balance on account */
balance?: number;
/** Account identifiers */
identities: {
evm: {
&#x27;bloxberg:8996&#x27;: string[];
@@ -459,13 +525,17 @@
latitude: number;
longitude: number;
};
/** User&#x27;s location */
location: {
area?: string;
area_name: string;
area_type?: string;
};
/** Products or services provided by user. */
products: string[];
/** Business category of user. */
category?: string;
/** Personal identifying information of user */
vcard: {
email: [
{
@@ -500,22 +570,31 @@
/** Meta signature interface */
interface Signature {
/** Algorithm used */
algo: string;
/** Data that was signed. */
data: string;
/** Message digest */
digest: string;
/** Encryption engine used. */
engine: string;
}
/** Meta object interface */
interface Meta {
/** Account details */
data: AccountDetails;
/** Meta store id */
id: string;
/** Signature used during write. */
signature: Signature;
}
/** Meta response interface */
interface MetaResponse {
/** Meta store id */
id: string;
/** Meta object */
m: Meta;
}

41
docs/compodoc/interfaces/Action.html
View File

@@ -138,6 +138,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Action performed </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -167,6 +173,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Action approval status. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -196,6 +208,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Action ID </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -225,6 +243,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Admin&#39;s role in the system </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -254,6 +278,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Admin who initialized the action. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -262,28 +292,39 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface Action {
/** Action ID */
id: number;
/** Admin who initialized the action. */
user: string;
/** Admin&#x27;s role in the system */
role: string;
/** Action performed */
action: string;
/** Action approval status. */
approval: boolean;
}
/** Area name object interface */
interface AreaName {
/** Name of area */
name: string;
/** Locations that map to that area name. */
locations: Array&lt;string&gt;;
}
/** Area type object interface */
interface AreaType {
/** Type of area */
name: string;
/** Areas that map to that area type. */
area: Array&lt;string&gt;;
}
/** Category object interface */
interface Category {
/** Business category */
name: string;
/** Products that map to that category. */
products: Array&lt;string&gt;;
}

23
docs/compodoc/interfaces/AreaName.html
View File

@@ -129,6 +129,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Locations that map to that area name. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -158,6 +164,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Name of area </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -166,28 +178,39 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface Action {
/** Action ID */
id: number;
/** Admin who initialized the action. */
user: string;
/** Admin&#x27;s role in the system */
role: string;
/** Action performed */
action: string;
/** Action approval status. */
approval: boolean;
}
/** Area name object interface */
interface AreaName {
/** Name of area */
name: string;
/** Locations that map to that area name. */
locations: Array&lt;string&gt;;
}
/** Area type object interface */
interface AreaType {
/** Type of area */
name: string;
/** Areas that map to that area type. */
area: Array&lt;string&gt;;
}
/** Category object interface */
interface Category {
/** Business category */
name: string;
/** Products that map to that category. */
products: Array&lt;string&gt;;
}

23
docs/compodoc/interfaces/AreaType.html
View File

@@ -129,6 +129,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Areas that map to that area type. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -158,6 +164,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Type of area </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -166,28 +178,39 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface Action {
/** Action ID */
id: number;
/** Admin who initialized the action. */
user: string;
/** Admin&#x27;s role in the system */
role: string;
/** Action performed */
action: string;
/** Action approval status. */
approval: boolean;
}
/** Area name object interface */
interface AreaName {
/** Name of area */
name: string;
/** Locations that map to that area name. */
locations: Array&lt;string&gt;;
}
/** Area type object interface */
interface AreaType {
/** Type of area */
name: string;
/** Areas that map to that area type. */
area: Array&lt;string&gt;;
}
/** Category object interface */
interface Category {
/** Business category */
name: string;
/** Products that map to that category. */
products: Array&lt;string&gt;;
}

23
docs/compodoc/interfaces/BlocksBloom.html
View File

@@ -274,40 +274,63 @@ interface BlocksBloom {
/** 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;
}

23
docs/compodoc/interfaces/Category.html
View File

@@ -129,6 +129,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Business category </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -158,6 +164,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Products that map to that category. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -166,28 +178,39 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface Action {
/** Action ID */
id: number;
/** Admin who initialized the action. */
user: string;
/** Admin&#x27;s role in the system */
role: string;
/** Action performed */
action: string;
/** Action approval status. */
approval: boolean;
}
/** Area name object interface */
interface AreaName {
/** Name of area */
name: string;
/** Locations that map to that area name. */
locations: Array&lt;string&gt;;
}
/** Area type object interface */
interface AreaType {
/** Type of area */
name: string;
/** Areas that map to that area type. */
area: Array&lt;string&gt;;
}
/** Category object interface */
interface Category {
/** Business category */
name: string;
/** Products that map to that category. */
products: Array&lt;string&gt;;
}

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>

37
docs/compodoc/interfaces/Meta.html
View File

@@ -132,6 +132,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account details </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -161,6 +167,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Meta store id </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -190,6 +202,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Signature used during write. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -198,11 +216,17 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface AccountDetails {
/** Account registration day */
date_registered: number;
/** User&#x27;s gender */
gender: string;
/** Age of user */
age?: string;
/** Type of account */
type?: string;
/** Token balance on account */
balance?: number;
/** Account identifiers */
identities: {
evm: {
&#x27;bloxberg:8996&#x27;: string[];
@@ -211,13 +235,17 @@
latitude: number;
longitude: number;
};
/** User&#x27;s location */
location: {
area?: string;
area_name: string;
area_type?: string;
};
/** Products or services provided by user. */
products: string[];
/** Business category of user. */
category?: string;
/** Personal identifying information of user */
vcard: {
email: [
{
@@ -252,22 +280,31 @@
/** Meta signature interface */
interface Signature {
/** Algorithm used */
algo: string;
/** Data that was signed. */
data: string;
/** Message digest */
digest: string;
/** Encryption engine used. */
engine: string;
}
/** Meta object interface */
interface Meta {
/** Account details */
data: AccountDetails;
/** Meta store id */
id: string;
/** Signature used during write. */
signature: Signature;
}
/** Meta response interface */
interface MetaResponse {
/** Meta store id */
id: string;
/** Meta object */
m: Meta;
}

31
docs/compodoc/interfaces/MetaResponse.html
View File

@@ -129,6 +129,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Meta store id </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -158,6 +164,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Meta object </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -166,11 +178,17 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface AccountDetails {
/** Account registration day */
date_registered: number;
/** User&#x27;s gender */
gender: string;
/** Age of user */
age?: string;
/** Type of account */
type?: string;
/** Token balance on account */
balance?: number;
/** Account identifiers */
identities: {
evm: {
&#x27;bloxberg:8996&#x27;: string[];
@@ -179,13 +197,17 @@
latitude: number;
longitude: number;
};
/** User&#x27;s location */
location: {
area?: string;
area_name: string;
area_type?: string;
};
/** Products or services provided by user. */
products: string[];
/** Business category of user. */
category?: string;
/** Personal identifying information of user */
vcard: {
email: [
{
@@ -220,22 +242,31 @@
/** Meta signature interface */
interface Signature {
/** Algorithm used */
algo: string;
/** Data that was signed. */
data: string;
/** Message digest */
digest: string;
/** Encryption engine used. */
engine: string;
}
/** Meta object interface */
interface Meta {
/** Account details */
data: AccountDetails;
/** Meta store id */
id: string;
/** Signature used during write. */
signature: Signature;
}
/** Meta response interface */
interface MetaResponse {
/** Meta store id */
id: string;
/** Meta object */
m: Meta;
}

43
docs/compodoc/interfaces/Signature.html
View File

@@ -135,6 +135,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Algorithm used </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -164,6 +170,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Data that was signed. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -193,6 +205,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Message digest </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -222,6 +240,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Encryption engine used. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -230,11 +254,17 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface AccountDetails {
/** Account registration day */
date_registered: number;
/** User&#x27;s gender */
gender: string;
/** Age of user */
age?: string;
/** Type of account */
type?: string;
/** Token balance on account */
balance?: number;
/** Account identifiers */
identities: {
evm: {
&#x27;bloxberg:8996&#x27;: string[];
@@ -243,13 +273,17 @@
latitude: number;
longitude: number;
};
/** User&#x27;s location */
location: {
area?: string;
area_name: string;
area_type?: string;
};
/** Products or services provided by user. */
products: string[];
/** Business category of user. */
category?: string;
/** Personal identifying information of user */
vcard: {
email: [
{
@@ -284,22 +318,31 @@
/** Meta signature interface */
interface Signature {
/** Algorithm used */
algo: string;
/** Data that was signed. */
data: string;
/** Message digest */
digest: string;
/** Encryption engine used. */
engine: string;
}
/** Meta object interface */
interface Meta {
/** Account details */
data: AccountDetails;
/** Meta store id */
id: string;
/** Signature used during write. */
signature: Signature;
}
/** Meta response interface */
interface MetaResponse {
/** Meta store id */
id: string;
/** Meta object */
m: Meta;
}

35
docs/compodoc/interfaces/Staff.html
View File

@@ -138,6 +138,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Comment made on the public key. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -167,6 +173,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Email used to create the public key. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -196,6 +208,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Name of the owner of the public key </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -225,6 +243,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Tags added to the public key. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -254,6 +278,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>User ID of the owner of the public key. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -262,10 +292,15 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface Staff {
/** Comment made on the public key. */
comment: string;
/** Email used to create the public key. */
email: string;
/** Name of the owner of the public key */
name: string;
/** Tags added to the public key. */
tag: number;
/** User ID of the owner of the public key. */
userid: string;
}

56
docs/compodoc/interfaces/Token.html
View File

@@ -149,6 +149,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Address of the deployed token contract. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -178,6 +184,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Number of decimals to convert to smallest denomination of the token. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -207,6 +219,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Name of the token. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -241,6 +259,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Address of account that deployed token. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -275,6 +299,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Token reserve to token minting ratio. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -304,6 +334,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Token reserve information </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -333,6 +369,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Total token supply. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -362,6 +404,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>The unique token symbol. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -370,18 +418,26 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">interface Token {
/** Name of the token. */
name: string;
/** The unique token symbol. */
symbol: string;
/** Address of the deployed token contract. */
address: string;
/** Total token supply. */
supply: string;
/** Number of decimals to convert to smallest denomination of the token. */
decimals: string;
/** Token reserve information */
reserves: {
&#x27;0xa686005CE37Dce7738436256982C3903f2E4ea8E&#x27;?: {
weight: string;
balance: string;
};
};
/** Token reserve to token minting ratio. */
reserveRatio?: string;
/** Address of account that deployed token. */
owner?: string;
}

82
docs/compodoc/interfaces/Transaction.html
View File

@@ -148,6 +148,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Address of the transaction sender. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -177,6 +183,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account information of the transaction recipient. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -206,6 +218,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Account information of the transaction sender. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -235,6 +253,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Address of the transaction recipient. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -264,6 +288,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction token information. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -293,6 +323,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction mining information. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -327,6 +363,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Type of transaction. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -356,6 +398,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Amount of tokens transacted. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -365,56 +413,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>

64
docs/compodoc/interfaces/Tx.html
View File

@@ -138,6 +138,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction block number. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -167,6 +173,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction mining status. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -196,6 +208,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Time transaction was mined. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -225,6 +243,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Hash generated by transaction. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -254,6 +278,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Index of transaction in block. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -263,56 +293,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>

52
docs/compodoc/interfaces/TxToken.html
View File

@@ -132,6 +132,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Address of the deployed token contract. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -161,6 +167,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>Name of the token. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -190,6 +202,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>The unique token symbol. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -199,56 +217,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>

23
docs/compodoc/interfaces/W3.html
View File

@@ -129,6 +129,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>An active web3 instance connected to the blockchain network. </p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
@@ -158,6 +164,12 @@
<tr>
<td class="col-md-4">
<div class="io-description"><p>The connection socket to the blockchain network. </p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
@@ -166,14 +178,23 @@
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">class Settings {
/** Web3 Object */
w3: W3 &#x3D; {
engine: undefined,
provider: undefined,
};
/** A resource for searching through blocks on the blockchain network. */
scanFilter: any;
/** CIC Registry instance */
registry: any;
/** Transaction Helper instance */
txHelper: any;
/**
* Initialize the settings.
*
* @param scanFilter - A resource for searching through blocks on the blockchain network.
*/
constructor(scanFilter: any) {
this.scanFilter &#x3D; scanFilter;
}
@@ -181,7 +202,9 @@
/** Web3 object interface */
interface W3 {
/** An active web3 instance connected to the blockchain network. */
engine: any;
/** The connection socket to the blockchain network. */
provider: any;
}