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 2.9.1 (#2391)

Browse Source
This commit is contained in:
pdp2121
2023-07-18 16:29:32 -04:00
committed by GitHub
parent d158770c24
commit 5ec6729c61
302 changed files with 3145 additions and 4132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/interfaces/OrderBookStream.html
View File

@@ -34,7 +34,7 @@ field.</p>
<ul class="tsd-hierarchy">
<li><span class="target">OrderBookStream</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L346">packages/xrpl/src/models/methods/subscribe.ts:346</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L346">packages/xrpl/src/models/methods/subscribe.ts:346</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">
@@ -60,58 +60,58 @@ field.</p>
<h3 class="tsd-anchor-link"><span>engine_<wbr/>result</span><a href="#engine_result" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">engine_<wbr/>result</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L349">packages/xrpl/src/models/methods/subscribe.ts:349</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L349">packages/xrpl/src/models/methods/subscribe.ts:349</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="engine_result_code" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>engine_<wbr/>result_<wbr/>code</span><a href="#engine_result_code" 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"><span class="tsd-kind-property">engine_<wbr/>result_<wbr/>code</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L350">packages/xrpl/src/models/methods/subscribe.ts:350</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L350">packages/xrpl/src/models/methods/subscribe.ts:350</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="engine_result_message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>engine_<wbr/>result_<wbr/>message</span><a href="#engine_result_message" 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"><span class="tsd-kind-property">engine_<wbr/>result_<wbr/>message</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L351">packages/xrpl/src/models/methods/subscribe.ts:351</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L351">packages/xrpl/src/models/methods/subscribe.ts:351</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_current_index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ledger_<wbr/>current_<wbr/>index</span><a href="#ledger_current_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"><span class="tsd-kind-property">ledger_<wbr/>current_<wbr/>index</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L352">packages/xrpl/src/models/methods/subscribe.ts:352</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L352">packages/xrpl/src/models/methods/subscribe.ts:352</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_hash" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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"><span class="tsd-kind-property">ledger_<wbr/>hash</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L353">packages/xrpl/src/models/methods/subscribe.ts:353</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L353">packages/xrpl/src/models/methods/subscribe.ts:353</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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"><span class="tsd-kind-property">ledger_<wbr/>index</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L354">packages/xrpl/src/models/methods/subscribe.ts:354</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L354">packages/xrpl/src/models/methods/subscribe.ts:354</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="meta" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>meta</span><a href="#meta" 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"><span class="tsd-kind-property">meta</span><span class="tsd-signature-symbol">:</span> <a href="TransactionMetadata.html" class="tsd-signature-type tsd-kind-interface">TransactionMetadata</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L355">packages/xrpl/src/models/methods/subscribe.ts:355</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L355">packages/xrpl/src/models/methods/subscribe.ts:355</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>status</span><a href="#status" 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"><span class="tsd-kind-property">status</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L347">packages/xrpl/src/models/methods/subscribe.ts:347</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L347">packages/xrpl/src/models/methods/subscribe.ts:347</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>transaction</span><a href="#transaction" 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"><span class="tsd-kind-property">transaction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L356">packages/xrpl/src/models/methods/subscribe.ts:356</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L356">packages/xrpl/src/models/methods/subscribe.ts:356</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;transaction&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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L348">packages/xrpl/src/models/methods/subscribe.ts:348</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L348">packages/xrpl/src/models/methods/subscribe.ts:348</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="validated" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>validated</span><a href="#validated" 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"><span class="tsd-kind-property">validated</span><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/6a31d4d2/packages/xrpl/src/models/methods/subscribe.ts#L367">packages/xrpl/src/models/methods/subscribe.ts:367</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/models/methods/subscribe.ts#L367">packages/xrpl/src/models/methods/subscribe.ts:367</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -385,6 +385,9 @@ field.</p>
<li><a href="../types/Stream.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Stream</span></a></li>
<li><a href="../types/StreamType.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Stream<wbr/>Type</span></a></li>
<li><a href="../types/Transaction.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Transaction</span></a></li>
<li><a href="../modules.html#deriveAddress" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>derive<wbr/>Address</span></a></li>
<li><a href="../modules.html#deriveKeypair" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>derive<wbr/>Keypair</span></a></li>
<li><a href="../modules.html#verifyKeypairSignature" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>verify<wbr/>Keypair<wbr/>Signature</span></a></li>
<li><a href="../variables/hashes.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>hashes</span></a></li>
<li><a href="../functions/authorizeChannel.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>authorize<wbr/>Channel</span></a></li>
<li><a href="../functions/classicAddressToXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>classic<wbr/>Address<wbr/>ToXAddress</span></a></li>
@@ -398,8 +401,6 @@ field.</p>
<li><a href="../functions/decodeNodePublic.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decode<wbr/>Node<wbr/>Public</span></a></li>
<li><a href="../functions/decodeSeed.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decode<wbr/>Seed</span></a></li>
<li><a href="../functions/decodeXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decodeXAddress</span></a></li>
<li><a href="../functions/deriveAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>derive<wbr/>Address</span></a></li>
<li><a href="../functions/deriveKeypair.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>derive<wbr/>Keypair</span></a></li>
<li><a href="../functions/deriveXAddress.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>deriveXAddress</span></a></li>
<li><a href="../functions/dropsToXrp.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>drops<wbr/>To<wbr/>Xrp</span></a></li>
<li><a href="../functions/encode.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>encode</span></a></li>
@@ -437,7 +438,6 @@ field.</p>
<li><a href="../functions/transferRateToDecimal.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>transfer<wbr/>Rate<wbr/>To<wbr/>Decimal</span></a></li>
<li><a href="../functions/unixTimeToRippleTime.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>unix<wbr/>Time<wbr/>To<wbr/>Ripple<wbr/>Time</span></a></li>
<li><a href="../functions/validate.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>validate</span></a></li>
<li><a href="../functions/verifyKeypairSignature.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>verify<wbr/>Keypair<wbr/>Signature</span></a></li>
<li><a href="../functions/verifyPaymentChannelClaim.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>verify<wbr/>Payment<wbr/>Channel<wbr/>Claim</span></a></li>
<li><a href="../functions/verifySignature.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>verify<wbr/>Signature</span></a></li>
<li><a href="../functions/xAddressToClassicAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>x<wbr/>Address<wbr/>To<wbr/>Classic<wbr/>Address</span></a></li>