ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-29 16:45:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: update reference docs (#1928)

Browse Source 
* npm run docgen

* fix: update docgen info in CONTRIBUTING.md
This commit is contained in:
Elliot Lee
2022-02-10 15:22:11 -08:00
committed by GitHub
parent 1e30b4cb43
commit 1258615a0c
163 changed files with 1278 additions and 1236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/interfaces/ValidationStream.html
View File

@@ -2,45 +2,45 @@
<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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L183">packages/xrpl/src/models/methods/subscribe.ts:183</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</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 id="amendments" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> amendments<a href="#amendments" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L183">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L185">packages/xrpl/src/models/methods/subscribe.ts:185</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="base_fee" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> base_<wbr/>fee<a href="#base_fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L185">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L190">packages/xrpl/src/models/methods/subscribe.ts:190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link">flags<a href="#flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L190">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L199">packages/xrpl/src/models/methods/subscribe.ts:199</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="full" class="tsd-anchor"></a><h3 class="tsd-anchor-link">full<a href="#full" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L199">packages/xrpl/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&#39;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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L206">packages/xrpl/src/models/methods/subscribe.ts:206</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L206">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L208">packages/xrpl/src/models/methods/subscribe.ts:208</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L208">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L213">packages/xrpl/src/models/methods/subscribe.ts:213</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="load_fee" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> load_<wbr/>fee<a href="#load_fee" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L213">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L218">packages/xrpl/src/models/methods/subscribe.ts:218</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="master_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> master_<wbr/>key<a href="#master_key" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L218">packages/xrpl/src/models/methods/subscribe.ts:218</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The validator&#39;s master public key, if the validator is using a validator
token, in the XRP Ledger&#39;s base58 format.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L223">packages/xrpl/src/models/methods/subscribe.ts:223</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reserve_base" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> reserve_<wbr/>base<a href="#reserve_base" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L223">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L228">packages/xrpl/src/models/methods/subscribe.ts:228</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reserve_inc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> reserve_<wbr/>inc<a href="#reserve_inc" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L228">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L230">packages/xrpl/src/models/methods/subscribe.ts:230</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="signature" class="tsd-anchor"></a><h3 class="tsd-anchor-link">signature<a href="#signature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L230">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L232">packages/xrpl/src/models/methods/subscribe.ts:232</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="signing_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link">signing_<wbr/>time<a href="#signing_time" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L232">packages/xrpl/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 id="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">&quot;validationReceived&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseStream.type</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L178">packages/xrpl/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 id="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/XRPLF/xrpl.js/blob/61107e0a/packages/xrpl/src/models/methods/subscribe.ts#L239">packages/xrpl/src/models/methods/subscribe.ts:239</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link">type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;validationReceived&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseStream.type</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L178">packages/xrpl/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 id="validation_public_key" class="tsd-anchor"></a><h3 class="tsd-anchor-link">validation_<wbr/>public_<wbr/>key<a href="#validation_public_key" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/XRPLF/xrpl.js/blob/1e30b4cb/packages/xrpl/src/models/methods/subscribe.ts#L239">packages/xrpl/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&#39;s base58 format. This identifies the validator
sending the message and can also be used to verify the signature. If the