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.11.0 (#2591)

Browse Source 
Update HISTORY.md + Run docgen
This commit is contained in:
Jackson Mills
2023-11-30 13:27:12 -08:00
committed by GitHub
parent 98abafbf12
commit 99dd0eb44c
341 changed files with 6499 additions and 2655 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/interfaces/PathFindCreateRequest.html
View File

@@ -32,7 +32,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<ul class="tsd-hierarchy">
<li><span class="target">PathFindCreateRequest</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L11">packages/xrpl/src/models/methods/pathFind.ts:11</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L11">packages/xrpl/src/models/methods/pathFind.ts:11</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,13 +60,13 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from BasePathFindRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L16">packages/xrpl/src/models/methods/baseMethod.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L16">packages/xrpl/src/models/methods/baseMethod.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="command" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>command</span><a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;path_find&quot;</span></div><aside class="tsd-sources">
<p>Inherited from BasePathFindRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L6">packages/xrpl/src/models/methods/pathFind.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L6">packages/xrpl/src/models/methods/pathFind.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">destination_<wbr/>account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -74,7 +74,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L19">packages/xrpl/src/models/methods/pathFind.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L19">packages/xrpl/src/models/methods/pathFind.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">destination_<wbr/>amount</span><span class="tsd-signature-symbol">:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></div>
@@ -83,7 +83,7 @@ transaction.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L24">packages/xrpl/src/models/methods/pathFind.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L24">packages/xrpl/src/models/methods/pathFind.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">id</span><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>
@@ -94,7 +94,7 @@ know which request prompted which response.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from BasePathFindRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L12">packages/xrpl/src/models/methods/baseMethod.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L12">packages/xrpl/src/models/methods/baseMethod.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="paths" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>paths</span><a href="#paths" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">paths</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Path.html" class="tsd-signature-type tsd-kind-type-alias">Path</a><span class="tsd-signature-symbol">[]</span></div>
@@ -104,7 +104,7 @@ about, or to check the overall cost to make a payment along a certain path.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L32">packages/xrpl/src/models/methods/pathFind.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L32">packages/xrpl/src/models/methods/pathFind.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">send_<wbr/>max</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></div>
@@ -112,7 +112,7 @@ about, or to check the overall cost to make a payment along a certain path.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L26">packages/xrpl/src/models/methods/pathFind.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L26">packages/xrpl/src/models/methods/pathFind.ts:26</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">source_<wbr/>account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -121,13 +121,13 @@ Account that would be sending a payment.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L17">packages/xrpl/src/models/methods/pathFind.ts:17</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L17">packages/xrpl/src/models/methods/pathFind.ts:17</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="subcommand" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>subcommand</span><a href="#subcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">subcommand</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;create&quot;</span></div><aside class="tsd-sources">
<p>Overrides BasePathFindRequest.subcommand</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/pathFind.ts#L12">packages/xrpl/src/models/methods/pathFind.ts:12</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/pathFind.ts#L12">packages/xrpl/src/models/methods/pathFind.ts:12</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -243,6 +243,8 @@ Account that would be sending a payment.</p>
<li><a href="ClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Client<wbr/>Options</span></a></li>
<li><a href="ConsensusStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Consensus<wbr/>Stream</span></a></li>
<li><a href="CreatedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Created<wbr/>Node</span></a></li>
<li><a href="DIDDelete.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DIDDelete</span></a></li>
<li><a href="DIDSet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DIDSet</span></a></li>
<li><a href="DeletedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deleted<wbr/>Node</span></a></li>
<li><a href="DepositAuthorizedRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Authorized<wbr/>Request</span></a></li>
<li><a href="DepositAuthorizedResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Authorized<wbr/>Response</span></a></li>
@@ -327,6 +329,8 @@ Account that would be sending a payment.</p>
<li><a href="RipplePathFindPathOption.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Path<wbr/>Option</span></a></li>
<li><a href="RipplePathFindRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Request</span></a></li>
<li><a href="RipplePathFindResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Response</span></a></li>
<li><a href="ServerDefinitionsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Definitions<wbr/>Request</span></a></li>
<li><a href="ServerDefinitionsResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Definitions<wbr/>Response</span></a></li>
<li><a href="ServerInfoRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Info<wbr/>Request</span></a></li>
<li><a href="ServerInfoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Info<wbr/>Response</span></a></li>
<li><a href="ServerStateRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>State<wbr/>Request</span></a></li>