release: xrpl@3.0.0-beta.1 and friends (#2592)

Release beta versions of all the packages and fix history file version numbers for first beta.
This commit is contained in:
Caleb Kniffen
2023-11-30 16:57:44 -06:00
parent 38b385969b
commit 63c71a162d
354 changed files with 4725 additions and 2665 deletions

View File

@@ -37,7 +37,7 @@ in its raw format. Expects a response in the form of a <a href="LedgerEntryRespo
<ul class="tsd-hierarchy">
<li><span class="target">LedgerEntryRequest</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L22">packages/xrpl/src/models/methods/ledgerEntry.ts:22</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L22">packages/xrpl/src/models/methods/ledgerEntry.ts:22</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">
@@ -54,6 +54,7 @@ in its raw format. Expects a response in the form of a <a href="LedgerEntryRespo
<a href="LedgerEntryRequest.html#check" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>check?</span></a>
<a href="LedgerEntryRequest.html#command" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>command</span></a>
<a href="LedgerEntryRequest.html#deposit_preauth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>deposit_<wbr/>preauth?</span></a>
<a href="LedgerEntryRequest.html#did" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>did?</span></a>
<a href="LedgerEntryRequest.html#directory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>directory?</span></a>
<a href="LedgerEntryRequest.html#escrow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>escrow?</span></a>
<a href="LedgerEntryRequest.html#id" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>id?</span></a>
@@ -78,7 +79,7 @@ to the an <a href="AccountInfoRequest.html" class="tsd-kind-interface">AccountIn
</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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L58">packages/xrpl/src/models/methods/ledgerEntry.ts:58</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L58">packages/xrpl/src/models/methods/ledgerEntry.ts:58</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="amm" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>amm</span><a href="#amm" 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">amm</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">asset</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">currency</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">issuer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">asset2</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">currency</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">issuer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -104,7 +105,7 @@ This is similar to amm_info method, but the ledger_entry version returns only th
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">issuer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L28">packages/xrpl/src/models/methods/ledgerEntry.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L28">packages/xrpl/src/models/methods/ledgerEntry.ts:28</a></li></ul></aside></section>
<section class="tsd-panel tsd-member 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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">api_<wbr/>version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -113,7 +114,7 @@ This is similar to amm_info method, but the ledger_entry version returns only th
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseRequest.html">BaseRequest</a>.<a href="BaseRequest.html#api_version">api_version</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/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/a46f4658/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"><a id="binary" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>binary</span><a href="#binary" 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">binary</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -123,17 +124,17 @@ default is false.</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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L44">packages/xrpl/src/models/methods/ledgerEntry.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L44">packages/xrpl/src/models/methods/ledgerEntry.ts:44</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="bridge" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>bridge</span><a href="#bridge" 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">bridge</span><span class="tsd-signature-symbol">?:</span> <a href="XChainBridge.html" class="tsd-signature-type tsd-kind-interface">XChainBridge</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L159">packages/xrpl/src/models/methods/ledgerEntry.ts:159</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L165">packages/xrpl/src/models/methods/ledgerEntry.ts:165</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="bridge_account" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>bridge_<wbr/>account</span><a href="#bridge_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">bridge_<wbr/>account</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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L157">packages/xrpl/src/models/methods/ledgerEntry.ts:157</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L163">packages/xrpl/src/models/methods/ledgerEntry.ts:163</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="check" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>check</span><a href="#check" 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">check</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -141,7 +142,7 @@ default is false.</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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L61">packages/xrpl/src/models/methods/ledgerEntry.ts:61</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L61">packages/xrpl/src/models/methods/ledgerEntry.ts:61</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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;ledger_entry&quot;</span></div>
@@ -150,7 +151,7 @@ default is false.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="BaseRequest.html">BaseRequest</a>.<a href="BaseRequest.html#command">command</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L23">packages/xrpl/src/models/methods/ledgerEntry.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L23">packages/xrpl/src/models/methods/ledgerEntry.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="deposit_preauth" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>deposit_<wbr/>preauth</span><a href="#deposit_preauth" 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">deposit_<wbr/>preauth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">authorized</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -173,7 +174,16 @@ requires owner and authorized sub-fields.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L68">packages/xrpl/src/models/methods/ledgerEntry.ts:68</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L68">packages/xrpl/src/models/methods/ledgerEntry.ts:68</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="did" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>did</span><a href="#did" 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">did</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Specify a DID object to retrieve. If a string, must be the
object ID of the DID object, as hexadecimal, or the account ID.</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/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L81">packages/xrpl/src/models/methods/ledgerEntry.ts:81</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="directory" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>directory</span><a href="#directory" 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">directory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">dir_root</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sub_index</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -201,7 +211,7 @@ Owner as a sub-field, plus optionally a <code>sub_index</code> sub-field.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L82">packages/xrpl/src/models/methods/ledgerEntry.ts:82</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L88">packages/xrpl/src/models/methods/ledgerEntry.ts:88</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="escrow" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>escrow</span><a href="#escrow" 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">escrow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">seq</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -223,7 +233,7 @@ escrow, as hexadecimal. If an object, requires owner and seq sub-fields.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L97">packages/xrpl/src/models/methods/ledgerEntry.ts:97</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L103">packages/xrpl/src/models/methods/ledgerEntry.ts:103</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>
@@ -234,12 +244,12 @@ know which request prompted which response.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseRequest.html">BaseRequest</a>.<a href="BaseRequest.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/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/a46f4658/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="index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>index</span><a href="#index" 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">index</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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L52">packages/xrpl/src/models/methods/ledgerEntry.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L52">packages/xrpl/src/models/methods/ledgerEntry.ts:52</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></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>
@@ -248,7 +258,7 @@ know which request prompted which response.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from LookupByLedgerRequest.ledger_hash</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/baseMethod.ts#L21">packages/xrpl/src/models/methods/baseMethod.ts:21</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/baseMethod.ts#L21">packages/xrpl/src/models/methods/baseMethod.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">ledger_<wbr/>index</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LedgerIndex.html" class="tsd-signature-type tsd-kind-type-alias">LedgerIndex</a></div>
@@ -257,7 +267,7 @@ know which request prompted which response.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from LookupByLedgerRequest.ledger_index</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/baseMethod.ts#L23">packages/xrpl/src/models/methods/baseMethod.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/baseMethod.ts#L23">packages/xrpl/src/models/methods/baseMethod.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="nft_page" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>nft_<wbr/>page</span><a href="#nft_page" 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">nft_<wbr/>page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -265,7 +275,7 @@ know which request prompted which response.</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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L155">packages/xrpl/src/models/methods/ledgerEntry.ts:155</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L161">packages/xrpl/src/models/methods/ledgerEntry.ts:161</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="offer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>offer</span><a href="#offer" 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">offer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">account</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">seq</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -288,7 +298,7 @@ to uniquely identify the offer.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L111">packages/xrpl/src/models/methods/ledgerEntry.ts:111</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L117">packages/xrpl/src/models/methods/ledgerEntry.ts:117</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="payment_channel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>payment_<wbr/>channel</span><a href="#payment_channel" 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">payment_<wbr/>channel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -296,7 +306,7 @@ to uniquely identify the offer.</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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L121">packages/xrpl/src/models/methods/ledgerEntry.ts:121</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L127">packages/xrpl/src/models/methods/ledgerEntry.ts:127</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ripple_state" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ripple_<wbr/>state</span><a href="#ripple_state" 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">ripple_<wbr/>state</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">accounts</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">currency</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -320,7 +330,7 @@ this RippleState object.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L128">packages/xrpl/src/models/methods/ledgerEntry.ts:128</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L134">packages/xrpl/src/models/methods/ledgerEntry.ts:134</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ticket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ticket</span><a href="#ticket" 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">ticket</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">ticket_sequence</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -343,7 +353,7 @@ sub-fields are required to uniquely specify the Ticket entry.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></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/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L143">packages/xrpl/src/models/methods/ledgerEntry.ts:143</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L149">packages/xrpl/src/models/methods/ledgerEntry.ts:149</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="xchain_owned_claim_id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>xchain_<wbr/>owned_<wbr/>claim_<wbr/>id</span><a href="#xchain_owned_claim_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">xchain_<wbr/>owned_<wbr/>claim_<wbr/>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-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">issuing_chain_door</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">issuing_chain_issue</span><span class="tsd-signature-symbol">: </span><a href="../types/Currency.html" class="tsd-signature-type tsd-kind-type-alias">Currency</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">locking_chain_door</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">locking_chain_issue</span><span class="tsd-signature-symbol">: </span><a href="../types/Currency.html" class="tsd-signature-type tsd-kind-type-alias">Currency</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">xchain_owned_claim_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><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -361,7 +371,7 @@ sub-fields are required to uniquely specify the Ticket entry.</p>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">xchain_<wbr/>owned_<wbr/>claim_<wbr/>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></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L161">packages/xrpl/src/models/methods/ledgerEntry.ts:161</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L167">packages/xrpl/src/models/methods/ledgerEntry.ts:167</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="xchain_owned_create_account_claim_id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>xchain_<wbr/>owned_<wbr/>create_<wbr/>account_<wbr/>claim_<wbr/>id</span><a href="#xchain_owned_create_account_claim_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">xchain_<wbr/>owned_<wbr/>create_<wbr/>account_<wbr/>claim_<wbr/>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-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">issuing_chain_door</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">issuing_chain_issue</span><span class="tsd-signature-symbol">: </span><a href="../types/Currency.html" class="tsd-signature-type tsd-kind-type-alias">Currency</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">locking_chain_door</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">locking_chain_issue</span><span class="tsd-signature-symbol">: </span><a href="../types/Currency.html" class="tsd-signature-type tsd-kind-type-alias">Currency</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">xchain_owned_create_account_claim_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><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -379,7 +389,7 @@ sub-fields are required to uniquely specify the Ticket entry.</p>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">xchain_<wbr/>owned_<wbr/>create_<wbr/>account_<wbr/>claim_<wbr/>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></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/ledgerEntry.ts#L171">packages/xrpl/src/models/methods/ledgerEntry.ts:171</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/ledgerEntry.ts#L177">packages/xrpl/src/models/methods/ledgerEntry.ts:177</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -408,6 +418,7 @@ sub-fields are required to uniquely specify the Ticket entry.</p>
<li><a href="#check" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>check</span></a></li>
<li><a href="#command" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>command</span></a></li>
<li><a href="#deposit_preauth" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>deposit_<wbr/>preauth</span></a></li>
<li><a href="#did" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>did</span></a></li>
<li><a href="#directory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>directory</span></a></li>
<li><a href="#escrow" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>escrow</span></a></li>
<li><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>id</span></a></li>
@@ -507,6 +518,8 @@ sub-fields are required to uniquely specify the Ticket entry.</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>
@@ -592,6 +605,8 @@ sub-fields are required to uniquely specify the Ticket entry.</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>
@@ -660,6 +675,7 @@ sub-fields are required to uniquely specify the Ticket entry.</p>
<li><a href="../types/StateAccountingFinal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>State<wbr/>Accounting<wbr/>Final</span></a></li>
<li><a href="../types/Stream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Stream</span></a></li>
<li><a href="../types/StreamType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Stream<wbr/>Type</span></a></li>
<li><a href="../types/SubmittableTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Submittable<wbr/>Transaction</span></a></li>
<li><a href="../types/Transaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Transaction</span></a></li>
<li><a href="../types/TransactionMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Transaction<wbr/>Metadata</span></a></li>
<li><a href="../variables/hashes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>hashes</span></a></li>