release: 3.0.0-beta.0 (#2533)

XRPLF · Oct 19, 2023 · 5eed65b · 5eed65b
1 parent 258ee13
commit 5eed65b
Show file tree

Hide file tree

Showing 350 changed files with 8,057 additions and 8,499 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -13,14 +13,16 @@
     --dark-hl-5: #CE9178;
     --light-hl-6: #AF00DB;
     --dark-hl-6: #C586C0;
-    --light-hl-7: #008000;
-    --dark-hl-7: #6A9955;
-    --light-hl-8: #267F99;
-    --dark-hl-8: #4EC9B0;
-    --light-hl-9: #098658;
-    --dark-hl-9: #B5CEA8;
-    --light-hl-10: #CD3131;
-    --dark-hl-10: #F44747;
+    --light-hl-7: #098658;
+    --dark-hl-7: #B5CEA8;
+    --light-hl-8: #000000FF;
+    --dark-hl-8: #D4D4D4;
+    --light-hl-9: #008000;
+    --dark-hl-9: #6A9955;
+    --light-hl-10: #267F99;
+    --dark-hl-10: #4EC9B0;
+    --light-hl-11: #CD3131;
+    --dark-hl-11: #F44747;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -37,6 +39,7 @@
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
     --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
     --code-background: var(--light-code-background);
 } }
 
@@ -52,6 +55,7 @@
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
     --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
     --code-background: var(--dark-code-background);
 } }
 
@@ -67,6 +71,7 @@
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
     --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
     --code-background: var(--light-code-background);
 }
 
@@ -82,6 +87,7 @@
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
     --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
     --code-background: var(--dark-code-background);
 }
 
@@ -96,4 +102,5 @@
 .hl-8 { color: var(--hl-8); }
 .hl-9 { color: var(--hl-9); }
 .hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/BroadcastClient.html b/docs/classes/BroadcastClient.html
diff --git a/docs/classes/Client.html b/docs/classes/Client.html
diff --git a/docs/classes/ConnectionError.html b/docs/classes/ConnectionError.html
diff --git a/docs/classes/DisconnectedError.html b/docs/classes/DisconnectedError.html
diff --git a/docs/classes/NotConnectedError.html b/docs/classes/NotConnectedError.html
diff --git a/docs/classes/NotFoundError.html b/docs/classes/NotFoundError.html
diff --git a/docs/classes/ResponseFormatError.html b/docs/classes/ResponseFormatError.html
diff --git a/docs/classes/RippledError.html b/docs/classes/RippledError.html
diff --git a/docs/classes/RippledNotInitializedError.html b/docs/classes/RippledNotInitializedError.html
diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html
diff --git a/docs/classes/UnexpectedError.html b/docs/classes/UnexpectedError.html
diff --git a/docs/classes/ValidationError.html b/docs/classes/ValidationError.html
diff --git a/docs/classes/Wallet.html b/docs/classes/Wallet.html
diff --git a/docs/classes/XRPLFaucetError.html b/docs/classes/XRPLFaucetError.html
diff --git a/docs/classes/XrplError.html b/docs/classes/XrplError.html
diff --git a/docs/enums/AMMDepositFlags.html b/docs/enums/AMMDepositFlags.html
diff --git a/docs/enums/AMMWithdrawFlags.html b/docs/enums/AMMWithdrawFlags.html
diff --git a/docs/enums/AccountSetAsfFlags.html b/docs/enums/AccountSetAsfFlags.html
diff --git a/docs/enums/AccountSetTfFlags.html b/docs/enums/AccountSetTfFlags.html
diff --git a/docs/enums/ECDSA.html b/docs/enums/ECDSA.html
@@ -22,7 +22,7 @@
 <li><a href="ECDSA.html">ECDSA</a></li></ul>
 <h1>Enumeration ECDSA</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/ECDSA.ts#L1">packages/xrpl/src/ECDSA.ts:1</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/ECDSA.ts#L1">packages/xrpl/src/ECDSA.ts:1</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">
@@ -39,12 +39,12 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>ed25519</span><a href="#ed25519" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">ed25519</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ed25519&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/ECDSA.ts#L2">packages/xrpl/src/ECDSA.ts:2</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/ECDSA.ts#L2">packages/xrpl/src/ECDSA.ts:2</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="secp256k1" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>secp256k1</span><a href="#secp256k1" 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-enum-member">secp256k1</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ecdsa-secp256k1&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/ECDSA.ts#L3">packages/xrpl/src/ECDSA.ts:3</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/ECDSA.ts#L3">packages/xrpl/src/ECDSA.ts:3</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -83,8 +83,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="PaymentFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Payment<wbr/>Flags</span></a></li>
 <li><a href="TrustSetFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Trust<wbr/>Set<wbr/>Flags</span></a></li>
 <li><a href="XChainModifyBridgeFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>XChain<wbr/>Modify<wbr/>Bridge<wbr/>Flags</span></a></li>
-<li><a href="../classes/BroadcastClient.html" class="deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Broadcast<wbr/>Client</span></a></li>
-<li><a href="../classes/Client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Client</span></a></li>
+<li><a href="../classes/Client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Client</span></a></li>
 <li><a href="../classes/ConnectionError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Connection<wbr/>Error</span></a></li>
 <li><a href="../classes/DisconnectedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Disconnected<wbr/>Error</span></a></li>
 <li><a href="../classes/NotConnectedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Not<wbr/>Connected<wbr/>Error</span></a></li>
@@ -164,6 +163,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../interfaces/EscrowFinish.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Escrow<wbr/>Finish</span></a></li>
 <li><a href="../interfaces/FeeRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Fee<wbr/>Request</span></a></li>
 <li><a href="../interfaces/FeeResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Fee<wbr/>Response</span></a></li>
+<li><a href="../interfaces/FundingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Funding<wbr/>Options</span></a></li>
 <li><a href="../interfaces/GatewayBalance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Gateway<wbr/>Balance</span></a></li>
 <li><a href="../interfaces/GatewayBalancesRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Gateway<wbr/>Balances<wbr/>Request</span></a></li>
 <li><a href="../interfaces/GatewayBalancesResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Gateway<wbr/>Balances<wbr/>Response</span></a></li>
@@ -260,7 +260,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../interfaces/TransactionAndMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>And<wbr/>Metadata</span></a></li>
 <li><a href="../interfaces/TransactionEntryRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Entry<wbr/>Request</span></a></li>
 <li><a href="../interfaces/TransactionEntryResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Entry<wbr/>Response</span></a></li>
-<li><a href="../interfaces/TransactionMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Metadata</span></a></li>
+<li><a href="../interfaces/TransactionMetadataBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Metadata<wbr/>Base</span></a></li>
 <li><a href="../interfaces/TransactionStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Stream</span></a></li>
 <li><a href="../interfaces/TrustSet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Trust<wbr/>Set</span></a></li>
 <li><a href="../interfaces/TrustSetFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Trust<wbr/>Set<wbr/>Flags<wbr/>Interface</span></a></li>
@@ -290,21 +290,25 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <li><a href="../types/LedgerDataLabeledLedgerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Data<wbr/>Labeled<wbr/>Ledger<wbr/>Entry</span></a></li>
 <li><a href="../types/LedgerDataLedgerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Data<wbr/>Ledger<wbr/>State</span></a></li>
 <li><a href="../types/LedgerIndex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Index</span></a></li>
+<li><a href="../types/MarkerRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Marker<wbr/>Request</span></a></li>
+<li><a href="../types/MarkerResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Marker<wbr/>Response</span></a></li>
 <li><a href="../types/Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Node</span></a></li>
 <li><a href="../types/Path.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Path</span></a></li>
 <li><a href="../types/PathFindRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Path<wbr/>Find<wbr/>Request</span></a></li>
 <li><a href="../types/PseudoTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pseudo<wbr/>Transaction</span></a></li>
 <li><a href="../types/Request.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Request</span></a></li>
+<li><a href="../types/RequestAllResponseMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Request<wbr/>All<wbr/>Response<wbr/>Map</span></a></li>
+<li><a href="../types/RequestResponseMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Request<wbr/>Response<wbr/>Map</span></a></li>
 <li><a href="../types/Response.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Response</span></a></li>
 <li><a href="../types/ServerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Server<wbr/>State</span></a></li>
 <li><a href="../types/SetFee.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Set<wbr/>Fee</span></a></li>
 <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/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>
-<li><a href="../functions/authorizeChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>authorize<wbr/>Channel</span></a></li>
-<li><a href="../functions/classicAddressToXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>classic<wbr/>Address<wbr/>ToXAddress</span></a></li>
+<li><a href="../functions/classicAddressToXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>classic<wbr/>Address<wbr/>ToXAddress</span></a></li>
 <li><a href="../functions/convertHexToString.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>Hex<wbr/>To<wbr/>String</span></a></li>
 <li><a href="../functions/convertStringToHex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>String<wbr/>To<wbr/>Hex</span></a></li>
 <li><a href="../functions/decimalToQuality.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decimal<wbr/>To<wbr/>Quality</span></a></li>