ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-24 22:25:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

release 2.6.0 (#2145)

Browse Source
This commit is contained in:
jonathanlei
2022-11-21 14:18:39 -08:00
committed by GitHub
parent 8921b6ac93
commit 93c8562e55
217 changed files with 3745 additions and 3649 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/interfaces/PathFindStream.html
View File

@@ -25,7 +25,7 @@ time.</p>
<ul class="tsd-hierarchy">
<li><span class="target">PathFindStream</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L382">packages/xrpl/src/models/methods/subscribe.ts:382</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L393">packages/xrpl/src/models/methods/subscribe.ts:393</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">
@@ -38,7 +38,7 @@ time.</p>
<a href="PathFindStream.html#destination_amount" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>destination_<wbr/>amount</span></a>
<a href="PathFindStream.html#full_reply" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>full_<wbr/>reply</span></a>
<a href="PathFindStream.html#id" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>id</span></a>
<a href="PathFindStream.html#send_max" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>send_<wbr/>max?</span></a>
<a href="PathFindStream.html#send_max" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>send_<wbr/>max</span></a>
<a href="PathFindStream.html#source_account" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>source_<wbr/>account</span></a>
<a href="PathFindStream.html#type" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><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>type</span></a>
</div></section></div></details></section></section>
@@ -46,26 +46,26 @@ time.</p>
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="alternatives" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>alternatives</span><a href="#alternatives" 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">alternatives<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>paths_computed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>source_amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
<div class="tsd-signature">alternatives<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>paths_computed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>source_amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Amount</span><span class="tsd-signature-symbol"> }</span></div>
<div class="tsd-comment tsd-typography"><p>Array of objects with suggested paths to take. If empty, then no paths
were found connecting the source and destination accounts.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L406">packages/xrpl/src/models/methods/subscribe.ts:406</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L417">packages/xrpl/src/models/methods/subscribe.ts:417</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="destination_account" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>destination_<wbr/>account</span><a href="#destination_account" 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">destination_<wbr/>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Unique address of the account that would receive a transaction.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L387">packages/xrpl/src/models/methods/subscribe.ts:387</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L398">packages/xrpl/src/models/methods/subscribe.ts:398</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="destination_amount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>destination_<wbr/>amount</span><a href="#destination_amount" 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">destination_<wbr/>amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div>
<div class="tsd-comment tsd-typography"><p>Currency Amount that the destination would receive in a transaction.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L389">packages/xrpl/src/models/methods/subscribe.ts:389</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L400">packages/xrpl/src/models/methods/subscribe.ts:400</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="full_reply" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>full_<wbr/>reply</span><a href="#full_reply" 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_<wbr/>reply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -76,34 +76,34 @@ find it.) Until you close the pathfinding request, rippled continues to
send updates each time a new ledger closes.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L397">packages/xrpl/src/models/methods/subscribe.ts:397</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L408">packages/xrpl/src/models/methods/subscribe.ts:408</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The ID provided in the WebSocket request is included again at this level.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L399">packages/xrpl/src/models/methods/subscribe.ts:399</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L410">packages/xrpl/src/models/methods/subscribe.ts:410</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="send_max" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>send_<wbr/>max</span><a href="#send_max" 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">send_<wbr/>max<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Amount</span></div>
<div class="tsd-comment tsd-typography"><p>Currency Amount that would be spent in the transaction.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L401">packages/xrpl/src/models/methods/subscribe.ts:401</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L412">packages/xrpl/src/models/methods/subscribe.ts:412</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="source_account" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>source_<wbr/>account</span><a href="#source_account" 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">source_<wbr/>account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Unique address that would send a transaction.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L385">packages/xrpl/src/models/methods/subscribe.ts:385</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L396">packages/xrpl/src/models/methods/subscribe.ts:396</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;path_find&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/91f4950b/packages/xrpl/src/models/methods/subscribe.ts#L383">packages/xrpl/src/models/methods/subscribe.ts:383</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/methods/subscribe.ts#L394">packages/xrpl/src/models/methods/subscribe.ts:394</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">
@@ -135,7 +135,7 @@ send updates each time a new ledger closes.</p>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#destination_amount" class="tsd-index-link"><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>destination_<wbr/>amount</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#full_reply" class="tsd-index-link"><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>full_<wbr/>reply</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#id" class="tsd-index-link"><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>id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#send_max" class="tsd-index-link"><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>send_<wbr/>max?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#send_max" class="tsd-index-link"><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>send_<wbr/>max</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#source_account" class="tsd-index-link"><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>source_<wbr/>account</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="PathFindStream.html#type" class="tsd-index-link"><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>type</a></li></ul></li></ul></nav></div></div>
<div class="container tsd-generator">