Release xrpl.js 2.7.0 (#2240)

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

View File

@@ -37,7 +37,7 @@ of an <a href="NoRippleCheckResponse.html">NoRippleCheckResponse</a>.</p>
<ul class="tsd-hierarchy">
<li><span class="target">NoRippleCheckRequest</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/norippleCheck.ts#L27">packages/xrpl/src/models/methods/norippleCheck.ts:27</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/norippleCheck.ts#L27">packages/xrpl/src/models/methods/norippleCheck.ts:27</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">
@@ -63,7 +63,7 @@ of an <a href="NoRippleCheckResponse.html">NoRippleCheckResponse</a>.</p>
<div class="tsd-comment tsd-typography"><p>A unique identifier for the account, most commonly the account&#39;s address.</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/norippleCheck.ts#L30">packages/xrpl/src/models/methods/norippleCheck.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/norippleCheck.ts#L30">packages/xrpl/src/models/methods/norippleCheck.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api_<wbr/>version</span><a href="#api_version" 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">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -71,13 +71,13 @@ of an <a href="NoRippleCheckResponse.html">NoRippleCheckResponse</a>.</p>
</div><aside class="tsd-sources">
<p>Inherited from BaseRequest.api_version</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;noripple_check&quot;</span></div><aside class="tsd-sources">
<p>Overrides BaseRequest.command</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/norippleCheck.ts#L28">packages/xrpl/src/models/methods/norippleCheck.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/norippleCheck.ts#L28">packages/xrpl/src/models/methods/norippleCheck.ts:28</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface 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 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>
@@ -87,14 +87,14 @@ know which request prompted which response.</p>
</div><aside class="tsd-sources">
<p>Inherited from BaseRequest.id</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fe480ec/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</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"><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">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>A 20-byte hex string for the ledger version to use.</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/norippleCheck.ts#L49">packages/xrpl/src/models/methods/norippleCheck.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/norippleCheck.ts#L49">packages/xrpl/src/models/methods/norippleCheck.ts:49</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"><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">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div>
@@ -102,7 +102,7 @@ know which request prompted which response.</p>
ledger automatically.</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/norippleCheck.ts#L54">packages/xrpl/src/models/methods/norippleCheck.ts:54</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/norippleCheck.ts#L54">packages/xrpl/src/models/methods/norippleCheck.ts:54</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>limit</span><a href="#limit" 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">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -110,7 +110,7 @@ ledger automatically.</p>
Defaults to 300.</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/norippleCheck.ts#L47">packages/xrpl/src/models/methods/norippleCheck.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/norippleCheck.ts#L47">packages/xrpl/src/models/methods/norippleCheck.ts:47</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="role" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>role</span><a href="#role" 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">role<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;user&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;gateway&quot;</span></div>
@@ -120,7 +120,7 @@ disable No Ripple on all trust lines. Users should have Default Ripple
disabled, and should enable No Ripple on all trust lines.</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/norippleCheck.ts#L37">packages/xrpl/src/models/methods/norippleCheck.ts:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/models/methods/norippleCheck.ts#L37">packages/xrpl/src/models/methods/norippleCheck.ts:37</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transactions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transactions</span><a href="#transactions" 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">transactions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -128,7 +128,7 @@ disabled, and should enable No Ripple on all trust lines.</p>
that you can sign and submit to fix the problems. Defaults to false.</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/norippleCheck.ts#L42">packages/xrpl/src/models/methods/norippleCheck.ts:42</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/norippleCheck.ts#L42">packages/xrpl/src/models/methods/norippleCheck.ts:42</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">