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

release: xrpl@3.0.0-beta.1 and friends (#2592)

Browse Source 
Release beta versions of all the packages and fix history file version numbers for first beta.
This commit is contained in:
Caleb Kniffen
2023-11-30 16:57:44 -06:00
parent 38b385969b
commit 63c71a162d
354 changed files with 4725 additions and 2665 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/interfaces/SubscribeRequest.html
View File

@@ -23,7 +23,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<h1>Interface SubscribeRequest</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>The subscribe method requests periodic notifications from the server when
certain events happen. Expects a response in the form of a.
certain events happen. Expects a response in the form of a
<a href="SubscribeResponse.html" class="tsd-kind-interface">SubscribeResponse</a>.</p>
</div>
<div class="tsd-comment tsd-typography"></div></section>
@@ -34,7 +34,7 @@ certain events happen. Expects a response in the form of a.
<ul class="tsd-hierarchy">
<li><span class="target">SubscribeRequest</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L47">packages/xrpl/src/models/methods/subscribe.ts:47</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L47">packages/xrpl/src/models/methods/subscribe.ts:47</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">
@@ -65,7 +65,7 @@ one of these accounts.</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/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L57">packages/xrpl/src/models/methods/subscribe.ts:57</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L57">packages/xrpl/src/models/methods/subscribe.ts:57</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="accounts_proposed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>accounts_<wbr/>proposed</span><a href="#accounts_proposed" 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">accounts_<wbr/>proposed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
@@ -73,7 +73,7 @@ one of these accounts.</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/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L59">packages/xrpl/src/models/methods/subscribe.ts:59</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L59">packages/xrpl/src/models/methods/subscribe.ts:59</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api_<wbr/>version</span><a href="#api_version" 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">api_<wbr/>version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -82,7 +82,7 @@ one of these accounts.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseRequest.html">BaseRequest</a>.<a href="BaseRequest.html#api_version">api_version</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/baseMethod.ts#L16">packages/xrpl/src/models/methods/baseMethod.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/baseMethod.ts#L16">packages/xrpl/src/models/methods/baseMethod.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="books" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>books</span><a href="#books" 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">books</span><span class="tsd-signature-symbol">?:</span> <a href="SubscribeBook.html" class="tsd-signature-type tsd-kind-interface">SubscribeBook</a><span class="tsd-signature-symbol">[]</span></div>
@@ -91,7 +91,7 @@ Below.</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/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L64">packages/xrpl/src/models/methods/subscribe.ts:64</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L64">packages/xrpl/src/models/methods/subscribe.ts:64</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="command" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>command</span><a href="#command" 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">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;subscribe&quot;</span></div>
@@ -100,7 +100,7 @@ Below.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="BaseRequest.html">BaseRequest</a>.<a href="BaseRequest.html#command">command</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L48">packages/xrpl/src/models/methods/subscribe.ts:48</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L48">packages/xrpl/src/models/methods/subscribe.ts:48</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
@@ -111,7 +111,7 @@ know which request prompted which response.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="BaseRequest.html">BaseRequest</a>.<a href="BaseRequest.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/258ee130/packages/xrpl/src/models/methods/baseMethod.ts#L12">packages/xrpl/src/models/methods/baseMethod.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/baseMethod.ts#L12">packages/xrpl/src/models/methods/baseMethod.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="streams" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>streams</span><a href="#streams" 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">streams</span><span class="tsd-signature-symbol">?:</span> <a href="../types/StreamType.html" class="tsd-signature-type tsd-kind-type-alias">StreamType</a><span class="tsd-signature-symbol">[]</span></div>
@@ -119,7 +119,7 @@ know which request prompted which response.</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/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L50">packages/xrpl/src/models/methods/subscribe.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L50">packages/xrpl/src/models/methods/subscribe.ts:50</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url</span><a href="#url" 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">url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -128,7 +128,7 @@ Admin-only.</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/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L69">packages/xrpl/src/models/methods/subscribe.ts:69</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L69">packages/xrpl/src/models/methods/subscribe.ts:69</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="url_password" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url_<wbr/>password</span><a href="#url_password" 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">url_<wbr/>password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -136,7 +136,7 @@ Admin-only.</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/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L73">packages/xrpl/src/models/methods/subscribe.ts:73</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L73">packages/xrpl/src/models/methods/subscribe.ts:73</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="url_username" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url_<wbr/>username</span><a href="#url_username" 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">url_<wbr/>username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -144,7 +144,7 @@ Admin-only.</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/258ee130/packages/xrpl/src/models/methods/subscribe.ts#L71">packages/xrpl/src/models/methods/subscribe.ts:71</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L71">packages/xrpl/src/models/methods/subscribe.ts:71</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -260,6 +260,8 @@ Admin-only.</p>
<li><a href="ClientOptions.html"><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>
@@ -345,6 +347,8 @@ Admin-only.</p>
<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>
@@ -413,6 +417,7 @@ Admin-only.</p>
<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/SubmittableTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Submittable<wbr/>Transaction</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>