grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
spencer/fix-tests
cic-staff-client/docs/compodoc/interfaces/Tx.html

420 lines
15 KiB
HTML
Raw Permalink Normal View History

Add documentation to models.
2021-05-12 08:40:21 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</title>
<meta name="description" content="">
<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">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content interface">
<div class="content-data">
<ol class="breadcrumb">
<li>Interfaces</li>
<li>Tx</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/_models/transaction.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Transaction data interface </p>
</p>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#block">block</a>
</li>
<li>
<a href="#success">success</a>
</li>
<li>
<a href="#timestamp">timestamp</a>
</li>
<li>
<a href="#txHash">txHash</a>
</li>
<li>
<a href="#txIndex">txIndex</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="inputs">Properties</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="block"></a>
<span class="name"><b>block</b><a href="#block"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>block: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction block number. </p>
</div>
</td>
</tr>
Add documentation to models.
2021-05-12 08:40:21 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="success"></a>
<span class="name"><b>success</b><a href="#success"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>success: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Transaction mining status. </p>
</div>
</td>
</tr>
Add documentation to models.
2021-05-12 08:40:21 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="timestamp"></a>
<span class="name"><b>timestamp</b><a href="#timestamp"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>timestamp: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Time transaction was mined. </p>
</div>
</td>
</tr>
Add documentation to models.
2021-05-12 08:40:21 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="txHash"></a>
<span class="name"><b>txHash</b><a href="#txHash"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>txHash: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Hash generated by transaction. </p>
</div>
</td>
</tr>
Add documentation to models.
2021-05-12 08:40:21 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="txIndex"></a>
<span class="name"><b>txIndex</b><a href="#txIndex"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>txIndex: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>Index of transaction in block. </p>
</div>
</td>
</tr>
Add documentation to models.
2021-05-12 08:40:21 +02:00
</tbody>
</table>
</section>
</div>
<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;;
/** Conversion object interface */
interface Conversion {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Final transaction token information. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
destinationToken: TxToken;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Initial transaction token amount. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
fromValue: number;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Initial transaction token information. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
sourceToken: TxToken;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Final transaction token amount. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
toValue: number;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Address of the initiator of the conversion. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
trader: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Conversion mining information. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
tx: Tx;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Account information of the initiator of the conversion. */
user: AccountDetails;
Add documentation to models.
2021-05-12 08:40:21 +02:00
}
/** Transaction object interface */
interface Transaction {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Address of the transaction sender. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
from: string;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Account information of the transaction recipient. */
recipient: AccountDetails;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Account information of the transaction sender. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
sender: AccountDetails;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Address of the transaction recipient. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
to: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Transaction token information. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
token: TxToken;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Transaction mining information. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
tx: Tx;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Type of transaction. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
type?: string;
Refactor order of item to follow alphabetical order.
2021-05-13 09:13:51 +02:00
/** Amount of tokens transacted. */
value: number;
Add documentation to models.
2021-05-12 08:40:21 +02:00
}
/** Transaction data interface */
interface Tx {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Transaction block number. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
block: number;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Transaction mining status. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
success: boolean;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Time transaction was mined. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
timestamp: number;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Hash generated by transaction. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
txHash: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Index of transaction in block. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
txIndex: number;
}
/** Transaction token object interface */
interface TxToken {
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Address of the deployed token contract. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
address: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** Name of the token. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
name: string;
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
/** The unique token symbol. */
Add documentation to models.
2021-05-12 08:40:21 +02:00
symbol: string;
}
/** @exports */
Finalize documentation on models.
2021-05-12 09:52:28 +02:00
export { Conversion, Transaction, Tx, TxToken };
Add documentation to models.
2021-05-12 08:40:21 +02:00
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
var COMPODOC_CURRENT_PAGE_URL = 'Tx.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<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 src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink