ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

2.11 release (#2442)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/interfaces/LedgerStream.html
View File

@@ -34,7 +34,7 @@ And provides some information about its contents.</p>
<ul class="tsd-hierarchy">
<li><span class="target">LedgerStream</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/models/methods/subscribe.ts#L97">packages/xrpl/src/models/methods/subscribe.ts:97</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L97">packages/xrpl/src/models/methods/subscribe.ts:97</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">
@@ -64,7 +64,7 @@ Transaction cost applies starting with the following ledger version.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L104">packages/xrpl/src/models/methods/subscribe.ts:104</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L104">packages/xrpl/src/models/methods/subscribe.ts:104</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="fee_ref" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>fee_<wbr/>ref</span><a href="#fee_ref" 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">fee_<wbr/>ref</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -72,7 +72,7 @@ Transaction cost applies starting with the following ledger version.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L106">packages/xrpl/src/models/methods/subscribe.ts:106</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L106">packages/xrpl/src/models/methods/subscribe.ts:106</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_hash" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><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>
@@ -80,7 +80,7 @@ Transaction cost applies starting with the following ledger version.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L108">packages/xrpl/src/models/methods/subscribe.ts:108</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L108">packages/xrpl/src/models/methods/subscribe.ts:108</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><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> <span class="tsd-signature-type">number</span></div>
@@ -88,7 +88,7 @@ Transaction cost applies starting with the following ledger version.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L110">packages/xrpl/src/models/methods/subscribe.ts:110</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L110">packages/xrpl/src/models/methods/subscribe.ts:110</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_time" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ledger_<wbr/>time</span><a href="#ledger_time" 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/>time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -96,7 +96,7 @@ Transaction cost applies starting with the following ledger version.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L112">packages/xrpl/src/models/methods/subscribe.ts:112</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L112">packages/xrpl/src/models/methods/subscribe.ts:112</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="reserve_base" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>reserve_<wbr/>base</span><a href="#reserve_base" 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">reserve_<wbr/>base</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -106,7 +106,7 @@ applies starting with the following ledger version.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L118">packages/xrpl/src/models/methods/subscribe.ts:118</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L118">packages/xrpl/src/models/methods/subscribe.ts:118</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="reserve_inc" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>reserve_<wbr/>inc</span><a href="#reserve_inc" 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">reserve_<wbr/>inc</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -116,7 +116,7 @@ reserve applies after this ledger.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L124">packages/xrpl/src/models/methods/subscribe.ts:124</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L124">packages/xrpl/src/models/methods/subscribe.ts:124</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="txn_count" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>txn_<wbr/>count</span><a href="#txn_count" 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">txn_<wbr/>count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -124,13 +124,13 @@ reserve applies after this ledger.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L126">packages/xrpl/src/models/methods/subscribe.ts:126</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L126">packages/xrpl/src/models/methods/subscribe.ts:126</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ledgerClosed&quot;</span></div><aside class="tsd-sources">
<p>Overrides BaseStream.type</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L98">packages/xrpl/src/models/methods/subscribe.ts:98</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L98">packages/xrpl/src/models/methods/subscribe.ts:98</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="validated_ledgers" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>validated_<wbr/>ledgers</span><a href="#validated_ledgers" 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">validated_<wbr/>ledgers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -141,7 +141,7 @@ connected but has not yet obtained a ledger from the network.</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/7361eb52/packages/xrpl/src/models/methods/subscribe.ts#L133">packages/xrpl/src/models/methods/subscribe.ts:133</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/49447a9be/packages/xrpl/src/models/methods/subscribe.ts#L133">packages/xrpl/src/models/methods/subscribe.ts:133</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -175,7 +175,9 @@ connected but has not yet obtained a ledger from the network.</p>
<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>
@@ -200,7 +202,17 @@ connected but has not yet obtained a ledger from the network.</p>
<li><a href="../classes/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="../classes/XRPLFaucetError.html"><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="../classes/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="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="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="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="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="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="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="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="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="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="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="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="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="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="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="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>
@@ -226,6 +238,7 @@ connected but has not yet obtained a ledger from the network.</p>
<li><a href="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="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="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="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="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="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="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>
@@ -437,6 +450,7 @@ connected but has not yet obtained a ledger from the network.</p>
<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">