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

@@ -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/a46f4658/packages/xrpl/src/client/index.ts#L90">packages/xrpl/src/client/index.ts:90</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L90">packages/xrpl/src/client/index.ts:90</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">
@@ -52,24 +52,24 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<div class="tsd-signature"><span class="tsd-kind-property">agent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Agent</span></div><aside class="tsd-sources">
<p>Inherited from ConnectionUserOptions.agent</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a46f4658/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/a58bf2663/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="authorization" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>authorization</span><a href="#authorization" 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">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/a46f4658/packages/xrpl/src/client/connection.ts#L32">packages/xrpl/src/client/connection.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/connection.ts#L32">packages/xrpl/src/client/connection.ts:32</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/a46f4658/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/a58bf2663/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="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/a46f4658/packages/xrpl/src/client/index.ts#L91">packages/xrpl/src/client/index.ts:91</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L91">packages/xrpl/src/client/index.ts:91</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>
@@ -80,18 +80,18 @@ 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/a46f4658/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/a58bf2663/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="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/a46f4658/packages/xrpl/src/client/index.ts#L92">packages/xrpl/src/client/index.ts:92</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L92">packages/xrpl/src/client/index.ts:92</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/a46f4658/packages/xrpl/src/client/index.ts#L93">packages/xrpl/src/client/index.ts:93</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L93">packages/xrpl/src/client/index.ts:93</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>
@@ -112,7 +112,7 @@ 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/a46f4658/packages/xrpl/src/client/connection.ts#L29">packages/xrpl/src/client/connection.ts:29</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/connection.ts#L29">packages/xrpl/src/client/connection.ts:29</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">