Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release 2.9.1 #2391

Merged
merged 3 commits into from
Jul 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
172 changes: 86 additions & 86 deletions docs/classes/BroadcastClient.html

Large diffs are not rendered by default.

168 changes: 84 additions & 84 deletions docs/classes/Client.html

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/classes/ConnectionError.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h4>Hierarchy</h4>
<li><a href="TimeoutError.html" class="tsd-signature-type tsd-kind-class">TimeoutError</a></li>
<li><a href="ResponseFormatError.html" class="tsd-signature-type tsd-kind-class">ResponseFormatError</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/6a31d4d2/packages/xrpl/src/errors.ts#L78">packages/xrpl/src/errors.ts:78</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/e760a489/packages/xrpl/src/errors.ts#L78">packages/xrpl/src/errors.ts:78</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">
Expand Down Expand Up @@ -85,27 +85,27 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <a href="ConnectionError.html" class="tsd-signature-type tsd-kind-class">ConnectionError</a></h4><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/6a31d4d2/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/e760a489/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>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<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/6a31d4d2/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/e760a489/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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></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/6a31d4d2/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/e760a489/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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></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/6a31d4d2/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/e760a489/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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></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">
Expand Down Expand Up @@ -158,7 +158,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<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/6a31d4d2/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/e760a489/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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
Expand All @@ -170,7 +170,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<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/6a31d4d2/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/e760a489/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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
Expand Down Expand Up @@ -461,6 +461,9 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li><a href="../types/Stream.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Stream</span></a></li>
<li><a href="../types/StreamType.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Stream<wbr/>Type</span></a></li>
<li><a href="../types/Transaction.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Transaction</span></a></li>
<li><a href="../modules.html#deriveAddress" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>derive<wbr/>Address</span></a></li>
<li><a href="../modules.html#deriveKeypair" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>derive<wbr/>Keypair</span></a></li>
<li><a href="../modules.html#verifyKeypairSignature" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>verify<wbr/>Keypair<wbr/>Signature</span></a></li>
<li><a href="../variables/hashes.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>hashes</span></a></li>
<li><a href="../functions/authorizeChannel.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>authorize<wbr/>Channel</span></a></li>
<li><a href="../functions/classicAddressToXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>classic<wbr/>Address<wbr/>ToXAddress</span></a></li>
Expand All @@ -474,8 +477,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li><a href="../functions/decodeNodePublic.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decode<wbr/>Node<wbr/>Public</span></a></li>
<li><a href="../functions/decodeSeed.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decode<wbr/>Seed</span></a></li>
<li><a href="../functions/decodeXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>decodeXAddress</span></a></li>
<li><a href="../functions/deriveAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>derive<wbr/>Address</span></a></li>
<li><a href="../functions/deriveKeypair.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>derive<wbr/>Keypair</span></a></li>
<li><a href="../functions/deriveXAddress.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>deriveXAddress</span></a></li>
<li><a href="../functions/dropsToXrp.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>drops<wbr/>To<wbr/>Xrp</span></a></li>
<li><a href="../functions/encode.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>encode</span></a></li>
Expand Down Expand Up @@ -513,7 +514,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li><a href="../functions/transferRateToDecimal.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>transfer<wbr/>Rate<wbr/>To<wbr/>Decimal</span></a></li>
<li><a href="../functions/unixTimeToRippleTime.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>unix<wbr/>Time<wbr/>To<wbr/>Ripple<wbr/>Time</span></a></li>
<li><a href="../functions/validate.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>validate</span></a></li>
<li><a href="../functions/verifyKeypairSignature.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>verify<wbr/>Keypair<wbr/>Signature</span></a></li>
<li><a href="../functions/verifyPaymentChannelClaim.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>verify<wbr/>Payment<wbr/>Channel<wbr/>Claim</span></a></li>
<li><a href="../functions/verifySignature.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>verify<wbr/>Signature</span></a></li>
<li><a href="../functions/xAddressToClassicAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>x<wbr/>Address<wbr/>To<wbr/>Classic<wbr/>Address</span></a></li>
Expand Down
Loading