release: xrpl.js 3.0 (#2633)

- @xrplf/isomorphic@1.0.0
 - ripple-address-codec@5.0.0
 - ripple-binary-codec@2.0.0
 - ripple-keypairs@2.0.0
 - @xrplf/secret-numbers@1.0.0
 - xrpl@3.0.0
This commit is contained in:
Caleb Kniffen
2024-02-01 15:48:48 -06:00
committed by GitHub
parent a58bf2663b
commit a09084289b
334 changed files with 2728 additions and 2594 deletions

View File

@@ -32,7 +32,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<ul class="tsd-hierarchy">
<li><span class="target">TransactionStream</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L265">packages/xrpl/src/models/methods/subscribe.ts:265</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L265">packages/xrpl/src/models/methods/subscribe.ts:265</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">
@@ -62,7 +62,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L269">packages/xrpl/src/models/methods/subscribe.ts:269</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L269">packages/xrpl/src/models/methods/subscribe.ts:269</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="engine_result_code" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>engine_<wbr/>result_<wbr/>code</span><a href="#engine_result_code" 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">engine_<wbr/>result_<wbr/>code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -70,7 +70,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L271">packages/xrpl/src/models/methods/subscribe.ts:271</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L271">packages/xrpl/src/models/methods/subscribe.ts:271</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="engine_result_message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>engine_<wbr/>result_<wbr/>message</span><a href="#engine_result_message" 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">engine_<wbr/>result_<wbr/>message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -78,7 +78,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L273">packages/xrpl/src/models/methods/subscribe.ts:273</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L273">packages/xrpl/src/models/methods/subscribe.ts:273</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_current_index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ledger_<wbr/>current_<wbr/>index</span><a href="#ledger_current_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/>current_<wbr/>index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -87,7 +87,7 @@ transaction is currently proposed.</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L278">packages/xrpl/src/models/methods/subscribe.ts:278</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L278">packages/xrpl/src/models/methods/subscribe.ts:278</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_hash" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
@@ -95,7 +95,7 @@ transaction is currently proposed.</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L280">packages/xrpl/src/models/methods/subscribe.ts:280</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L280">packages/xrpl/src/models/methods/subscribe.ts:280</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="ledger_index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <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>
@@ -103,7 +103,7 @@ transaction is currently proposed.</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L282">packages/xrpl/src/models/methods/subscribe.ts:282</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L282">packages/xrpl/src/models/methods/subscribe.ts:282</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="meta" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>meta</span><a href="#meta" 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">meta</span><span class="tsd-signature-symbol">?:</span> <a href="../types/TransactionMetadata.html" class="tsd-signature-type tsd-kind-type-alias">TransactionMetadata</a></div>
@@ -112,12 +112,12 @@ in detail.</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L287">packages/xrpl/src/models/methods/subscribe.ts:287</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L287">packages/xrpl/src/models/methods/subscribe.ts:287</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>status</span><a href="#status" 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">status</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L266">packages/xrpl/src/models/methods/subscribe.ts:266</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L266">packages/xrpl/src/models/methods/subscribe.ts:266</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="transaction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>transaction</span><a href="#transaction" 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">transaction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div>
@@ -125,13 +125,13 @@ in detail.</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L289">packages/xrpl/src/models/methods/subscribe.ts:289</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L289">packages/xrpl/src/models/methods/subscribe.ts:289</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;transaction&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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L267">packages/xrpl/src/models/methods/subscribe.ts:267</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L267">packages/xrpl/src/models/methods/subscribe.ts:267</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="validated" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>validated</span><a href="#validated" 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</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -141,7 +141,7 @@ validated.</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/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L295">packages/xrpl/src/models/methods/subscribe.ts:295</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L295">packages/xrpl/src/models/methods/subscribe.ts:295</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="warnings" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>warnings</span><a href="#warnings" 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">warnings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">message</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><span class="tsd-signature-symbol">[]</span></div>
@@ -153,7 +153,7 @@ validated.</p>
<li class="tsd-parameter">
<h5><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/packages/xrpl/src/models/methods/subscribe.ts#L296">packages/xrpl/src/models/methods/subscribe.ts:296</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/models/methods/subscribe.ts#L296">packages/xrpl/src/models/methods/subscribe.ts:296</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">