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

@@ -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">Client</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/client/index.ts#L167">packages/xrpl/src/client/index.ts:167</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L167">packages/xrpl/src/client/index.ts:167</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">
@@ -120,7 +120,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
</div><aside class="tsd-sources">
<p>Overrides EventEmitter&lt;EventTypes&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L215">packages/xrpl/src/client/index.ts:215</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L215">packages/xrpl/src/client/index.ts:215</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Abstraction</h2>
<section class="tsd-panel tsd-member"><a id="getBalances" class="tsd-anchor"></a>
@@ -172,7 +172,7 @@ ledger_index.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L900">packages/xrpl/src/client/index.ts:900</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L902">packages/xrpl/src/client/index.ts:902</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getLedgerIndex" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Ledger<wbr/>Index</span><a href="#getLedgerIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -187,7 +187,7 @@ ledger_index.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L1026">packages/xrpl/src/client/index.ts:1026</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L1028">packages/xrpl/src/client/index.ts:1028</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getOrderbook" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Orderbook</span><a href="#getOrderbook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -240,11 +240,11 @@ Can return more than this due to two calls being made. Defaults to 20.</p>
<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/client/index.ts#L968">packages/xrpl/src/client/index.ts:968</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L970">packages/xrpl/src/client/index.ts:970</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getXrpBalance" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Xrp<wbr/>Balance</span><a href="#getXrpBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getXrpBalance.getXrpBalance-1"><span class="tsd-kind-call-signature">get<wbr/>Xrp<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">address</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getXrpBalance.getXrpBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="getXrpBalance.getXrpBalance-1"><span class="tsd-kind-call-signature">get<wbr/>Xrp<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">address</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#getXrpBalance.getXrpBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves the XRP balance of a given account address.</p>
</div>
@@ -270,14 +270,14 @@ Can return more than this due to two calls being made. Defaults to 20.</p>
<div class="tsd-comment tsd-typography"><p>The index of the ledger to retrieve the balance from (optional).</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the XRP balance as a string.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the XRP balance as a number.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-0">wss</span><span class="hl-1">:</span><span class="hl-9">//s.altnet.rippletest.net:51233)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-0">balance</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">getXrpBalance</span><span class="hl-1">(</span><span class="hl-5">&#39;rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">balance</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">disconnect</span><span class="hl-1">()</span><br/><span class="hl-9">/// &#39;200&#39;</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L834">packages/xrpl/src/client/index.ts:834</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L836">packages/xrpl/src/client/index.ts:836</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Core</h2>
<section class="tsd-panel tsd-member"><a id="autofill" class="tsd-anchor"></a>
@@ -294,14 +294,14 @@ flags interfaces into numbers.</p>
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type tsd-kind-type-alias">Transaction</a></h4>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
<div class="tsd-comment tsd-typography"><p>A <a href="../types/Transaction.html" class="tsd-kind-type-alias">Transaction</a> in JSON format</p>
<div class="tsd-comment tsd-typography"><p>A <a href="../types/SubmittableTransaction.html" class="tsd-kind-type-alias">SubmittableTransaction</a> in JSON format</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signersCount</span>: <span class="tsd-signature-type">number</span></h5>
@@ -319,7 +319,7 @@ values will be used instead. By default, this is done as part of <code>submit</c
in an unsigned transaction along with your wallet to be submitted.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L631">packages/xrpl/src/client/index.ts:631</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L631">packages/xrpl/src/client/index.ts:631</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="submit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>submit</span><a href="#submit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -337,7 +337,7 @@ Steps performed on a transaction:</p>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/Transaction.html" class="tsd-signature-type tsd-kind-type-alias">Transaction</a></h5>
<h5><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h5>
<div class="tsd-comment tsd-typography"><p>A transaction to autofill, sign &amp; encode, and submit.</p>
</div></li>
<li>
@@ -369,7 +369,7 @@ Steps performed on a transaction:</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L695">packages/xrpl/src/client/index.ts:695</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L695">packages/xrpl/src/client/index.ts:695</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="submitAndWait" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>submit<wbr/>And<wbr/>Wait</span><a href="#submitAndWait" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -383,7 +383,7 @@ See <a href="https://xrpl.org/reliable-transaction-submission.html">Reliable Tra
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../types/Transaction.html" class="tsd-signature-type tsd-kind-type-alias">Transaction</a> = <a href="../types/Transaction.html" class="tsd-signature-type tsd-kind-type-alias">Transaction</a></h4></li></ul></section>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a> = <a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
@@ -435,7 +435,7 @@ an error will be thrown.</p>
ledger, the promise returned by <code>submitAndWait()</code> will be rejected with an error.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L767">packages/xrpl/src/client/index.ts:767</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L767">packages/xrpl/src/client/index.ts:767</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Faucet</h2>
<section class="tsd-panel tsd-member"><a id="fundWallet" class="tsd-anchor"></a>
@@ -485,7 +485,7 @@ And faucetPath so <code>fundWallet</code> can ask that faucet to fund your walle
<h4>Throws</h4><p>When either Client isn&#39;t connected or unable to fund wallet address.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L1099">packages/xrpl/src/client/index.ts:1099</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L1101">packages/xrpl/src/client/index.ts:1101</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Fee</h2>
<section class="tsd-panel tsd-member"><a id="feeCushion" class="tsd-anchor"></a>
@@ -496,7 +496,7 @@ required fee rises during submission of a transaction. Defaults to 1.2.</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/client/index.ts#L179">packages/xrpl/src/client/index.ts:179</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L179">packages/xrpl/src/client/index.ts:179</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="maxFeeXRP" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>max<wbr/>FeeXRP</span><a href="#maxFeeXRP" 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">max<wbr/>FeeXRP</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -505,7 +505,7 @@ number. Defaults to &#39;2&#39;.</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/client/index.ts#L187">packages/xrpl/src/client/index.ts:187</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L187">packages/xrpl/src/client/index.ts:187</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Network</h2>
<section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a>
@@ -519,7 +519,7 @@ number. Defaults to &#39;2&#39;.</p>
<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/client/index.ts#L285">packages/xrpl/src/client/index.ts:285</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L285">packages/xrpl/src/client/index.ts:285</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -540,7 +540,7 @@ before exiting your application.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L530">packages/xrpl/src/client/index.ts:530</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L530">packages/xrpl/src/client/index.ts:530</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="disconnect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>disconnect</span><a href="#disconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -558,7 +558,7 @@ need to switch to a different server.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L557">packages/xrpl/src/client/index.ts:557</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L557">packages/xrpl/src/client/index.ts:557</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="isConnected" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Connected</span><a href="#isConnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -573,7 +573,7 @@ need to switch to a different server.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L582">packages/xrpl/src/client/index.ts:582</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L582">packages/xrpl/src/client/index.ts:582</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -610,7 +610,7 @@ need to switch to a different server.</p>
</div><aside class="tsd-sources">
<p>Overrides EventEmitter.on</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L387">packages/xrpl/src/client/index.ts:387</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L387">packages/xrpl/src/client/index.ts:387</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="request" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -640,7 +640,7 @@ additional request body parameters.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="requestAll" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>request<wbr/>All</span><a href="#requestAll" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -686,7 +686,7 @@ requests as needed.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L425">packages/xrpl/src/client/index.ts:425</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L425">packages/xrpl/src/client/index.ts:425</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="requestNextPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>request<wbr/>Next<wbr/>Page</span><a href="#requestNextPage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -719,7 +719,7 @@ requests as needed.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L348">packages/xrpl/src/client/index.ts:348</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L348">packages/xrpl/src/client/index.ts:348</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Other</h2>
<section class="tsd-panel tsd-member"><a id="buildVersion" class="tsd-anchor"></a>
@@ -729,12 +729,12 @@ requests as needed.</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/client/index.ts#L199">packages/xrpl/src/client/index.ts:199</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L199">packages/xrpl/src/client/index.ts:199</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="connection" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>connection</span><a href="#connection" 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">connection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Connection</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L171">packages/xrpl/src/client/index.ts:171</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L171">packages/xrpl/src/client/index.ts:171</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="networkID" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>networkID</span><a href="#networkID" 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">networkID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
@@ -742,7 +742,7 @@ requests as needed.</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/client/index.ts#L193">packages/xrpl/src/client/index.ts:193</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L193">packages/xrpl/src/client/index.ts:193</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prefixed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>prefixed</span><a href="#prefixed" 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">prefixed</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">boolean</span></div><aside class="tsd-sources">
@@ -834,7 +834,7 @@ listeners.</p>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@@ -950,7 +950,7 @@ listeners.</p>
<section class="tsd-panel tsd-member"><a id="prepareTransaction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>prepare<wbr/>Transaction</span><a href="#prepareTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="prepareTransaction.prepareTransaction-1"><span class="tsd-kind-call-signature">prepare<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span>, <span class="tsd-kind-parameter">signersCount</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Transaction.html" class="tsd-signature-type tsd-kind-type-alias">Transaction</a><span class="tsd-signature-symbol">&gt;</span><a href="#prepareTransaction.prepareTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="prepareTransaction.prepareTransaction-1"><span class="tsd-kind-call-signature">prepare<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span>, <span class="tsd-kind-parameter">signersCount</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a><span class="tsd-signature-symbol">&gt;</span><a href="#prepareTransaction.prepareTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Deprecated: Use autofill instead, provided for users familiar with v1</p>
</div>
@@ -958,7 +958,7 @@ listeners.</p>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">transaction</span>: <a href="../types/Transaction.html" class="tsd-signature-type tsd-kind-type-alias">Transaction</a></h5>
<h5><span class="tsd-kind-parameter">transaction</span>: <a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h5>
<div class="tsd-comment tsd-typography"><p>A <a href="../types/Transaction.html" class="tsd-kind-type-alias">Transaction</a> in JSON format</p>
</div></li>
<li>
@@ -966,12 +966,12 @@ listeners.</p>
<div class="tsd-comment tsd-typography"><p>The expected number of signers for this transaction.
Only used for multisigned transactions.</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Transaction.html" class="tsd-signature-type tsd-kind-type-alias">Transaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography">
<h4>Deprecated</h4><p>Use autofill instead, provided for users familiar with v1</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/client/index.ts#L806">packages/xrpl/src/client/index.ts:806</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/client/index.ts#L808">packages/xrpl/src/client/index.ts:808</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@@ -1167,6 +1167,8 @@ Only used for multisigned transactions.</p>
<li><a href="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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>
@@ -1252,6 +1254,8 @@ Only used for multisigned transactions.</p>
<li><a href="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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>
@@ -1320,6 +1324,7 @@ Only used for multisigned transactions.</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>