Release xrpl.js 2.11.0 (#2591)

Update HISTORY.md + Run docgen
2025-12-06 17:27:59 +00:00 · 2023-11-30 13:27:12 -08:00
parent 98abafbf12
commit 99dd0eb44c
341 changed files with 6499 additions and 2655 deletions
--- a/docs/interfaces/ClientOptions.html
+++ b/docs/interfaces/ClientOptions.html
@@ -28,7 +28,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 <ul class="tsd-hierarchy">
 <li><span class="target">ClientOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/index.ts#L125">packages/xrpl/src/client/index.ts:125</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/index.ts#L127">packages/xrpl/src/client/index.ts:127</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">
@@ -57,24 +57,24 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 <div class="tsd-signature"><span class="tsd-kind-property">authorization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.authorization</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L31">packages/xrpl/src/client/connection.ts:31</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L31">packages/xrpl/src/client/connection.ts:31</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="certificate" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>certificate</span><a href="#certificate" 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">certificate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.certificate</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L35">packages/xrpl/src/client/connection.ts:35</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L35">packages/xrpl/src/client/connection.ts:35</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="connectionTimeout" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>connection<wbr/>Timeout</span><a href="#connectionTimeout" 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<wbr/>Timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.connectionTimeout</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L38">packages/xrpl/src/client/connection.ts:38</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L38">packages/xrpl/src/client/connection.ts:38</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="feeCushion" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>fee<wbr/>Cushion</span><a href="#feeCushion" 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/>Cushion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/index.ts#L126">packages/xrpl/src/client/index.ts:126</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/index.ts#L128">packages/xrpl/src/client/index.ts:128</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="headers" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>headers</span><a href="#headers" 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">headers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</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>
@@ -85,42 +85,42 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 <h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.headers</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L39">packages/xrpl/src/client/connection.ts:39</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L39">packages/xrpl/src/client/connection.ts:39</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="key" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>key</span><a href="#key" 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">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.key</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L33">packages/xrpl/src/client/connection.ts:33</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L33">packages/xrpl/src/client/connection.ts:33</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-flagOptional">Optional</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><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/index.ts#L127">packages/xrpl/src/client/index.ts:127</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/index.ts#L129">packages/xrpl/src/client/index.ts:129</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="passphrase" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>passphrase</span><a href="#passphrase" 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">passphrase</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.passphrase</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L34">packages/xrpl/src/client/connection.ts:34</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L34">packages/xrpl/src/client/connection.ts:34</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="proxy" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>proxy</span><a href="#proxy" 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">proxy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <p>Overrides ConnectionUserOptions.proxy</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/index.ts#L128">packages/xrpl/src/client/index.ts:128</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/index.ts#L130">packages/xrpl/src/client/index.ts:130</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="proxyAuthorization" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>proxy<wbr/>Authorization</span><a href="#proxyAuthorization" 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">proxy<wbr/>Authorization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.proxyAuthorization</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L30">packages/xrpl/src/client/connection.ts:30</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L30">packages/xrpl/src/client/connection.ts:30</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="timeout" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>timeout</span><a href="#timeout" 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">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <p>Overrides ConnectionUserOptions.timeout</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/index.ts#L129">packages/xrpl/src/client/index.ts:129</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/index.ts#L131">packages/xrpl/src/client/index.ts:131</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="trace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>trace</span><a href="#trace" 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">trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
@@ -141,13 +141,13 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.trace</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L28">packages/xrpl/src/client/connection.ts:28</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L28">packages/xrpl/src/client/connection.ts:28</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="trustedCertificates" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>trusted<wbr/>Certificates</span><a href="#trustedCertificates" 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">trusted<wbr/>Certificates</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
 <p>Inherited from ConnectionUserOptions.trustedCertificates</p>
 <ul>
-<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/client/connection.ts#L32">packages/xrpl/src/client/connection.ts:32</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/client/connection.ts#L32">packages/xrpl/src/client/connection.ts:32</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -267,6 +267,8 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 <li><a href="ClientOptions.html" class="current"><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>
@@ -351,6 +353,8 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 <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>