ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release xrpl.js 2.7.0 (#2240)

Browse Source
This commit is contained in:
Jackson Mills
2023-03-08 15:05:00 -08:00
committed by GitHub
parent 4ec8c99056
commit b3d3bc2f99
234 changed files with 2214 additions and 1767 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/interfaces/ValidationStream.html
View File

@@ -33,7 +33,7 @@ validation message is from a trusted validator.</p>
<ul class="tsd-hierarchy">
<li><span class="target">ValidationStream</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L182">packages/xrpl/src/models/methods/subscribe.ts:182</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L182">packages/xrpl/src/models/methods/subscribe.ts:182</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -67,14 +67,14 @@ validation message is from a trusted validator.</p>
Stream.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L188">packages/xrpl/src/models/methods/subscribe.ts:188</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L188">packages/xrpl/src/models/methods/subscribe.ts:188</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>base_<wbr/>fee</span><a href="#base_fee" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">base_<wbr/>fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The amendments this server wants to be added to the protocol.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L190">packages/xrpl/src/models/methods/subscribe.ts:190</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L190">packages/xrpl/src/models/methods/subscribe.ts:190</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="cookie" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cookie</span><a href="#cookie" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">cookie<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -84,14 +84,14 @@ concurrently, that usually indicates that multiple servers are incorrectly
configured to use the same validation key pair.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L198">packages/xrpl/src/models/methods/subscribe.ts:198</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L198">packages/xrpl/src/models/methods/subscribe.ts:198</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="data" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The contents of the validation message in its canonical binary form</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L202">packages/xrpl/src/models/methods/subscribe.ts:202</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L202">packages/xrpl/src/models/methods/subscribe.ts:202</a></li></ul></aside></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"><span>flags</span><a href="#flags" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -99,7 +99,7 @@ configured to use the same validation key pair.</p>
set by Fee voting.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L207">packages/xrpl/src/models/methods/subscribe.ts:207</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L207">packages/xrpl/src/models/methods/subscribe.ts:207</a></li></ul></aside></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"><span>full</span><a href="#full" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">full<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -111,7 +111,7 @@ particular ledger. A partial validation indicates that the validator is
still online but not keeping up with consensus.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L216">packages/xrpl/src/models/methods/subscribe.ts:216</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L216">packages/xrpl/src/models/methods/subscribe.ts:216</a></li></ul></aside></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"><span>ledger_<wbr/>hash</span><a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ledger_<wbr/>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -121,14 +121,14 @@ ledger. A partial validation indicates that the validator is still online
but not keeping up with consensus.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L223">packages/xrpl/src/models/methods/subscribe.ts:223</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L223">packages/xrpl/src/models/methods/subscribe.ts:223</a></li></ul></aside></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"><span>ledger_<wbr/>index</span><a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ledger_<wbr/>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The ledger index of the proposed ledger.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L225">packages/xrpl/src/models/methods/subscribe.ts:225</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L225">packages/xrpl/src/models/methods/subscribe.ts:225</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>load_<wbr/>fee</span><a href="#load_fee" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">load_<wbr/>fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -136,7 +136,7 @@ but not keeping up with consensus.</p>
enforcing, in fee units.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L230">packages/xrpl/src/models/methods/subscribe.ts:230</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L230">packages/xrpl/src/models/methods/subscribe.ts:230</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>master_<wbr/>key</span><a href="#master_key" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">master_<wbr/>key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -144,7 +144,7 @@ enforcing, in fee units.</p>
token, in the XRP Ledger&#39;s base58 format.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L235">packages/xrpl/src/models/methods/subscribe.ts:235</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L235">packages/xrpl/src/models/methods/subscribe.ts:235</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>reserve_<wbr/>base</span><a href="#reserve_base" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">reserve_<wbr/>base<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -152,7 +152,7 @@ token, in the XRP Ledger&#39;s base58 format.</p>
wants to set by fee voting.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L240">packages/xrpl/src/models/methods/subscribe.ts:240</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L240">packages/xrpl/src/models/methods/subscribe.ts:240</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>reserve_<wbr/>inc</span><a href="#reserve_inc" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">reserve_<wbr/>inc<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -160,27 +160,27 @@ wants to set by fee voting.</p>
validator wants to set by fee voting.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L245">packages/xrpl/src/models/methods/subscribe.ts:245</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L245">packages/xrpl/src/models/methods/subscribe.ts:245</a></li></ul></aside></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"><span>signature</span><a href="#signature" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The signature that the validator used to sign its vote for this ledger.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L247">packages/xrpl/src/models/methods/subscribe.ts:247</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L247">packages/xrpl/src/models/methods/subscribe.ts:247</a></li></ul></aside></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"><span>signing_<wbr/>time</span><a href="#signing_time" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">signing_<wbr/>time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>When this validation vote was signed, in seconds since the Ripple Epoch.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L249">packages/xrpl/src/models/methods/subscribe.ts:249</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L249">packages/xrpl/src/models/methods/subscribe.ts:249</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L183">packages/xrpl/src/models/methods/subscribe.ts:183</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L183">packages/xrpl/src/models/methods/subscribe.ts:183</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"><span>validation_<wbr/>public_<wbr/>key</span><a href="#validation_public_key" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">validation_<wbr/>public_<wbr/>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -190,7 +190,7 @@ 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><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/subscribe.ts#L256">packages/xrpl/src/models/methods/subscribe.ts:256</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/subscribe.ts#L256">packages/xrpl/src/models/methods/subscribe.ts:256</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">