2.11 release (#2442)

* update HISTORY

* update docgen

* update package versions
This commit is contained in:
Omar Khan
2023-08-24 13:44:29 -04:00
committed by GitHub
parent 49447a9beb
commit 37fbc03584
317 changed files with 13672 additions and 2801 deletions

View File

@@ -34,7 +34,7 @@ is connected to mainnet).</p>
<ul class="tsd-hierarchy">
<li><span class="target">XRPLFaucetError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/errors.ts#L129">packages/xrpl/src/errors.ts:129</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/errors.ts#L129">packages/xrpl/src/errors.ts:129</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">
@@ -85,7 +85,7 @@ is connected to mainnet).</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/errors.ts#L21">packages/xrpl/src/errors.ts:21</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
@@ -93,19 +93,19 @@ is connected to mainnet).</p>
<div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/errors.ts#L13">packages/xrpl/src/errors.ts:13</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>message</span><a href="#message" 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">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#message">message</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/errors.ts#L12">packages/xrpl/src/errors.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/errors.ts#L11">packages/xrpl/src/errors.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -160,7 +160,7 @@ us to customize its output:
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#inspect">inspect</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/errors.ts#L54">packages/xrpl/src/errors.ts:54</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/errors.ts#L54">packages/xrpl/src/errors.ts:54</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="toString" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" 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">
@@ -173,7 +173,7 @@ us to customize its output:
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="XrplError.html">XrplError</a>.<a href="XrplError.html#toString">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/errors.ts#L38">packages/xrpl/src/errors.ts:38</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/errors.ts#L38">packages/xrpl/src/errors.ts:38</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" 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">
@@ -226,7 +226,9 @@ us to customize its output:
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>xrpl</span></a>
<ul class="tsd-small-nested-navigation">
<li><a href="../modules/LedgerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Ledger<wbr/>Entry</span></a></li>
<li><a href="../enums/AccountSetAsfFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>Account<wbr/>Set<wbr/>Asf<wbr/>Flags</span></a></li>
<li><a href="../enums/AMMDepositFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>AMMDeposit<wbr/>Flags</span></a></li>
<li><a href="../enums/AMMWithdrawFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>AMMWithdraw<wbr/>Flags</span></a></li>
<li><a href="../enums/AccountSetAsfFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Account<wbr/>Set<wbr/>Asf<wbr/>Flags</span></a></li>
<li><a href="../enums/AccountSetTfFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Account<wbr/>Set<wbr/>Tf<wbr/>Flags</span></a></li>
<li><a href="../enums/ECDSA.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>ECDSA</span></a></li>
<li><a href="../enums/EnableAmendmentFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Enable<wbr/>Amendment<wbr/>Flags</span></a></li>
@@ -251,7 +253,17 @@ us to customize its output:
<li><a href="Wallet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Wallet</span></a></li>
<li><a href="XRPLFaucetError.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>XRPLFaucet<wbr/>Error</span></a></li>
<li><a href="XrplError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Xrpl<wbr/>Error</span></a></li>
<li><a href="../interfaces/AccountChannelsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Account<wbr/>Channels<wbr/>Request</span></a></li>
<li><a href="../interfaces/AMMBid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>AMMBid</span></a></li>
<li><a href="../interfaces/AMMCreate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMCreate</span></a></li>
<li><a href="../interfaces/AMMDelete.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMDelete</span></a></li>
<li><a href="../interfaces/AMMDeposit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMDeposit</span></a></li>
<li><a href="../interfaces/AMMDepositFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMDeposit<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/AMMInfoRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMInfo<wbr/>Request</span></a></li>
<li><a href="../interfaces/AMMInfoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMInfo<wbr/>Response</span></a></li>
<li><a href="../interfaces/AMMVote.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMVote</span></a></li>
<li><a href="../interfaces/AMMWithdraw.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMWithdraw</span></a></li>
<li><a href="../interfaces/AMMWithdrawFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMWithdraw<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/AccountChannelsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Channels<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountChannelsResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Channels<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountCurrenciesRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Currencies<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountCurrenciesResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Currencies<wbr/>Response</span></a></li>
@@ -277,6 +289,7 @@ us to customize its output:
<li><a href="../interfaces/AccountTxRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Tx<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountTxResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Tx<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountTxTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Tx<wbr/>Transaction</span></a></li>
<li><a href="../interfaces/AuthAccount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Auth<wbr/>Account</span></a></li>
<li><a href="../interfaces/Balance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Balance</span></a></li>
<li><a href="../interfaces/BaseRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Request</span></a></li>
<li><a href="../interfaces/BaseResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Response</span></a></li>
@@ -488,6 +501,7 @@ us to customize its output:
<li><a href="../functions/verifyKeypairSignature.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>verify<wbr/>Keypair<wbr/>Signature</span></a></li>
<li><a href="../functions/verifyPaymentChannelClaim.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>verify<wbr/>Payment<wbr/>Channel<wbr/>Claim</span></a></li>
<li><a href="../functions/verifySignature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>verify<wbr/>Signature</span></a></li>
<li><a href="../functions/walletFromSecretNumbers.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wallet<wbr/>From<wbr/>Secret<wbr/>Numbers</span></a></li>
<li><a href="../functions/xAddressToClassicAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>x<wbr/>Address<wbr/>To<wbr/>Classic<wbr/>Address</span></a></li>
<li><a href="../functions/xrpToDrops.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>xrp<wbr/>To<wbr/>Drops</span></a></li></ul></nav></div></div></div>
<div class="tsd-generator">