mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-23 05:35:48 +00:00
e813ec4bd3
Make all exported function parameters and return types show their shapes so that new developers can see how to use them in the docs.
48 lines
19 KiB
HTML
48 lines
19 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 | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/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-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">xrpl</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">xrpl</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-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The validations stream sends messages whenever it receives validation
|
|
messages, also called validation votes, regardless of whether or not the
|
|
validation message is from a trusted validator.</p>
|
|
</div></div></section><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/34f172cc/src/models/methods/subscribe.ts#L183">src/models/methods/subscribe.ts:183</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The value validationReceived indicates this is from the validations
|
|
Stream.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L185">src/models/methods/subscribe.ts:185</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The amendments this server wants to be added to the protocol.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L190">src/models/methods/subscribe.ts:190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The unscaled transaction cost (reference_fee value) this server wants to
|
|
set by Fee voting.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L199">src/models/methods/subscribe.ts:199</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Bit-mask of flags added to this validation message. The flag 0x80000000
|
|
indicates that the validation signature is fully-canonical. The flag
|
|
0x00000001 indicates that this is a full validation; otherwise it's a
|
|
partial validation. Partial validations are not meant to vote for any
|
|
particular ledger. A partial validation indicates that the validator is
|
|
still online but not keeping up with consensus.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L206">src/models/methods/subscribe.ts:206</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, this is a full validation. Otherwise, this is a partial
|
|
validation. Partial validations are not meant to vote for any particular
|
|
ledger. A partial validation indicates that the validator is still online
|
|
but not keeping up with consensus.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L208">src/models/methods/subscribe.ts:208</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ledger index of the proposed ledger.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L213">src/models/methods/subscribe.ts:213</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The local load-scaled transaction cost this validator is currently
|
|
enforcing, in fee units.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L218">src/models/methods/subscribe.ts:218</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The validator's master public key, if the validator is using a validator
|
|
token, in the XRP Ledger's base58 format.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L223">src/models/methods/subscribe.ts:223</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The minimum reserve requirement (<code>account_reserve</code> value) this validator
|
|
wants to set by fee voting.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L228">src/models/methods/subscribe.ts:228</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The increment in the reserve requirement (owner_reserve value) this
|
|
validator wants to set by fee voting.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L230">src/models/methods/subscribe.ts:230</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The signature that the validator used to sign its vote for this ledger.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L232">src/models/methods/subscribe.ts:232</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>When this validation vote was signed, in seconds since the Ripple Epoch.</p>
|
|
</div></div></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/34f172cc/src/models/methods/subscribe.ts#L178">src/models/methods/subscribe.ts:178</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/34f172cc/src/models/methods/subscribe.ts#L239">src/models/methods/subscribe.ts:239</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The public key from the key-pair that the validator used to sign the
|
|
message, in the XRP Ledger's base58 format. This identifies the validator
|
|
sending the message and can also be used to verify the signature. If the
|
|
validator is using a token, this is an ephemeral public key.</p>
|
|
</div></div></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><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><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></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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><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><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html> |