mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-07 14:25:49 +00:00
351 lines
18 KiB
HTML
351 lines
18 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>ValidationStream | ripple-lib</title>
|
|
<meta name="description" content="Documentation for ripple-lib">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">ripple-lib</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">ripple-lib</a>
|
|
</li>
|
|
<li>
|
|
<a href="ValidationStream.html">ValidationStream</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface ValidationStream</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="tsd-signature-type">BaseStream</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">ValidationStream</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#amendments" class="tsd-kind-icon">amendments</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#base_fee" class="tsd-kind-icon">base_<wbr>fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#flags" class="tsd-kind-icon">flags</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#full" class="tsd-kind-icon">full</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#load_fee" class="tsd-kind-icon">load_<wbr>fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#master_key" class="tsd-kind-icon">master_<wbr>key</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#signature" class="tsd-kind-icon">signature</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#signing_time" class="tsd-kind-icon">signing_<wbr>time</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ValidationStream.html#type" class="tsd-kind-icon">type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationStream.html#validation_public_key" class="tsd-kind-icon">validation_<wbr>public_<wbr>key</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="amendments" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> amendments</h3>
|
|
<div class="tsd-signature tsd-kind-icon">amendments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L52">src/models/methods/subscribe.ts:52</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="base_fee" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> base_<wbr>fee</h3>
|
|
<div class="tsd-signature tsd-kind-icon">base_<wbr>fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L53">src/models/methods/subscribe.ts:53</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="flags" class="tsd-anchor"></a>
|
|
<h3>flags</h3>
|
|
<div class="tsd-signature tsd-kind-icon">flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L54">src/models/methods/subscribe.ts:54</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="full" class="tsd-anchor"></a>
|
|
<h3>full</h3>
|
|
<div class="tsd-signature tsd-kind-icon">full<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L55">src/models/methods/subscribe.ts:55</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="ledger_hash" class="tsd-anchor"></a>
|
|
<h3>ledger_<wbr>hash</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L56">src/models/methods/subscribe.ts:56</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="ledger_index" class="tsd-anchor"></a>
|
|
<h3>ledger_<wbr>index</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L57">src/models/methods/subscribe.ts:57</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="load_fee" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr>fee</h3>
|
|
<div class="tsd-signature tsd-kind-icon">load_<wbr>fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L58">src/models/methods/subscribe.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="master_key" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> master_<wbr>key</h3>
|
|
<div class="tsd-signature tsd-kind-icon">master_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L59">src/models/methods/subscribe.ts:59</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="reserve_base" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> reserve_<wbr>base</h3>
|
|
<div class="tsd-signature tsd-kind-icon">reserve_<wbr>base<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L60">src/models/methods/subscribe.ts:60</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="reserve_inc" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> reserve_<wbr>inc</h3>
|
|
<div class="tsd-signature tsd-kind-icon">reserve_<wbr>inc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L61">src/models/methods/subscribe.ts:61</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="signature" class="tsd-anchor"></a>
|
|
<h3>signature</h3>
|
|
<div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L62">src/models/methods/subscribe.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="signing_time" class="tsd-anchor"></a>
|
|
<h3>signing_<wbr>time</h3>
|
|
<div class="tsd-signature tsd-kind-icon">signing_<wbr>time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L63">src/models/methods/subscribe.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a name="type" class="tsd-anchor"></a>
|
|
<h3>type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"validationReceived"</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Overrides BaseStream.type</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L51">src/models/methods/subscribe.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="validation_public_key" class="tsd-anchor"></a>
|
|
<h3>validation_<wbr>public_<wbr>key</h3>
|
|
<div class="tsd-signature tsd-kind-icon">validation_<wbr>public_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L64">src/models/methods/subscribe.ts:64</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface">
|
|
<a href="ValidationStream.html" class="tsd-kind-icon">Validation<wbr>Stream</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#amendments" class="tsd-kind-icon">amendments</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#base_fee" class="tsd-kind-icon">base_<wbr>fee</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#flags" class="tsd-kind-icon">flags</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#full" class="tsd-kind-icon">full</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#load_fee" class="tsd-kind-icon">load_<wbr>fee</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#master_key" class="tsd-kind-icon">master_<wbr>key</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#signature" class="tsd-kind-icon">signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#signing_time" class="tsd-kind-icon">signing_<wbr>time</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
|
<a href="ValidationStream.html#type" class="tsd-kind-icon">type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ValidationStream.html#validation_public_key" class="tsd-kind-icon">validation_<wbr>public_<wbr>key</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |