ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-04 21:15:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
d3b03a536d4d3d3194ffb21a457618060f0cdd28
xahau.js/docs/classes/Client.html
Caleb Kniffen a09084289b 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
2024-02-01 15:48:48 -06:00

1390 lines
210 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><script src="https://cmp.osano.com/AzyjT6TIZMlgyLyy8/ad2447d5-f101-40df-b92e-d6452b5ecac0/osano.js"></script><script>
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-M7HKJJ3');
</script><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Client | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M7HKJJ3" height=0 width=0 style="display:none;visibility:hidden"></iframe></noscript><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base="..">
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<div class="field">
<div id="tsd-toolbar-links"></div></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-content">
<div class="tsd-page-title">
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">xrpl</a></li>
<li><a href="Client.html">Client</a></li></ul>
<h1>Class Client</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>Client for interacting with rippled servers.</p>
</div>
<div class="tsd-comment tsd-typography"></div></section>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type ">EventEmitter</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">EventTypes</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li><span class="target">Client</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L167">packages/xrpl/src/client/index.ts:167</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">
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Constructor</h3>
<div class="tsd-index-list"><a href="Client.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Abstraction</h3>
<div class="tsd-index-list"><a href="Client.html#getBalances" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>get<wbr/>Balances</span></a>
<a href="Client.html#getLedgerIndex" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Ledger<wbr/>Index</span></a>
<a href="Client.html#getOrderbook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Orderbook</span></a>
<a href="Client.html#getXrpBalance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Xrp<wbr/>Balance</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Core</h3>
<div class="tsd-index-list"><a href="Client.html#autofill" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>autofill</span></a>
<a href="Client.html#submit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>submit</span></a>
<a href="Client.html#submitAndWait" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>submit<wbr/>And<wbr/>Wait</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Faucet</h3>
<div class="tsd-index-list"><a href="Client.html#fundWallet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fund<wbr/>Wallet</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Fee</h3>
<div class="tsd-index-list"><a href="Client.html#feeCushion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>fee<wbr/>Cushion</span></a>
<a href="Client.html#maxFeeXRP" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max<wbr/>FeeXRP</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Network</h3>
<div class="tsd-index-list"><a href="Client.html#url" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g></svg><span>url</span></a>
<a href="Client.html#connect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>connect</span></a>
<a href="Client.html#disconnect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disconnect</span></a>
<a href="Client.html#isConnected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Connected</span></a>
<a href="Client.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
<a href="Client.html#request" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request</span></a>
<a href="Client.html#requestAll" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request<wbr/>All</span></a>
<a href="Client.html#requestNextPage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request<wbr/>Next<wbr/>Page</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Other</h3>
<div class="tsd-index-list"><a href="Client.html#buildVersion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>build<wbr/>Version</span></a>
<a href="Client.html#connection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>connection</span></a>
<a href="Client.html#networkID" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>networkID</span></a>
<a href="Client.html#prefixed" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prefixed</span></a>
<a href="Client.html#addListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Listener</span></a>
<a href="Client.html#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a>
<a href="Client.html#eventNames" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>event<wbr/>Names</span></a>
<a href="Client.html#getServerInfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Info</span></a>
<a href="Client.html#listenerCount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
<a href="Client.html#listeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a>
<a href="Client.html#off" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a>
<a href="Client.html#once" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a>
<a href="Client.html#prepareTransaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepare<wbr/>Transaction</span></a>
<a href="Client.html#removeAllListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a>
<a href="Client.html#removeListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Constructor</h2>
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Client"><span class="tsd-kind-constructor-signature">new <wbr/>Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">server</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a><a href="#constructor.new_Client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Creates a new Client with a websocket connection to a rippled server.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">server</span>: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>URL of the server to connect to.</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/ClientOptions.html" class="tsd-signature-type tsd-kind-interface">ClientOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography"><p>Options for client settings.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h4>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-0">Client</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-5">&quot;xrpl&quot;</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<p>Overrides EventEmitter&lt;EventTypes&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L215">packages/xrpl/src/client/index.ts:215</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Abstraction</h2>
<section class="tsd-panel tsd-member"><a id="getBalances" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Balances</span><a href="#getBalances" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getBalances.getBalances-1"><span class="tsd-kind-call-signature">get<wbr/>Balances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">address</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">currency</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">issuer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">value</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><span class="tsd-signature-symbol">&gt;</span><a href="#getBalances.getBalances-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get XRP/non-XRP balances for an account.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">address</span>: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Address of the account to retrieve balances for.</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">ledger_hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">ledger_index</span><span class="tsd-signature-symbol">?: </span><a href="../types/LedgerIndex.html" class="tsd-signature-type tsd-kind-type-alias">LedgerIndex</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">limit</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">peer</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></h5>
<div class="tsd-comment tsd-typography"><p>Allows the client to specify a ledger_hash, ledger_index,
filter by peer, and/or limit number of balances.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ledger_<wbr/>hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Retrieve the account balances at the ledger with
a given ledger_hash.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ledger_<wbr/>index</span><span class="tsd-signature-symbol">?: </span><a href="../types/LedgerIndex.html" class="tsd-signature-type tsd-kind-type-alias">LedgerIndex</a></h5>
<div class="tsd-comment tsd-typography"><p>Retrieve the account balances at a given
ledger_index.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>Limit number of balances to return.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">peer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Filter balances by peer.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">currency</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">issuer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">value</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><span class="tsd-signature-symbol">&gt;</span></h4><p>An array of XRP/non-XRP balances for the given account.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><br/><span class="hl-2">async</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">getAccountBalances</span><span class="hl-1">(</span><span class="hl-0">address</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">options</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">ledger_index:</span><span class="hl-1"> </span><span class="hl-5">&#39;validated&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">limit:</span><span class="hl-1"> </span><span class="hl-7">10</span><br/><span class="hl-1"> };</span><br/><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">balances</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">xrplClient</span><span class="hl-1">.</span><span class="hl-4">getBalances</span><span class="hl-1">(</span><span class="hl-0">address</span><span class="hl-1">, </span><span class="hl-0">options</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">&#39;Account Balances:&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">balances</span><span class="hl-1">.</span><span class="hl-4">forEach</span><span class="hl-1">((</span><span class="hl-0">balance</span><span class="hl-1">) </span><span class="hl-2">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`Currency: </span><span class="hl-2">${</span><span class="hl-0">balance</span><span class="hl-8">.</span><span class="hl-0">currency</span><span class="hl-2">}</span><span class="hl-5">`</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`Value: </span><span class="hl-2">${</span><span class="hl-0">balance</span><span class="hl-8">.</span><span class="hl-0">value</span><span class="hl-2">}</span><span class="hl-5">`</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`Issuer: </span><span class="hl-2">${</span><span class="hl-0">balance</span><span class="hl-8">.</span><span class="hl-0">issuer</span><span class="hl-2">}</span><span class="hl-5">`</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">&#39;---&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">&#39;Error retrieving account balances:&#39;</span><span class="hl-1">, </span><span class="hl-0">error</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">address</span><span class="hl-1"> = </span><span class="hl-5">&#39;rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-4">getAccountBalances</span><span class="hl-1">(</span><span class="hl-0">address</span><span class="hl-1">);</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">disconnect</span><span class="hl-1">();</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L902">packages/xrpl/src/client/index.ts:902</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getLedgerIndex" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Ledger<wbr/>Index</span><a href="#getLedgerIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getLedgerIndex.getLedgerIndex-1"><span class="tsd-kind-call-signature">get<wbr/>Ledger<wbr/>Index</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#getLedgerIndex.getLedgerIndex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Returns the index of the most recently validated ledger.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The most recently validated ledger index.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">ledgerIndex</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">getLedgerIndex</span><span class="hl-1">()</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">ledgerIndex</span><span class="hl-1">)</span><br/><span class="hl-9">// 884039</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L1028">packages/xrpl/src/client/index.ts:1028</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getOrderbook" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Orderbook</span><a href="#getOrderbook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getOrderbook.getOrderbook-1"><span class="tsd-kind-call-signature">get<wbr/>Orderbook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">currency1</span>, <span class="tsd-kind-parameter">currency2</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">buy</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type tsd-kind-interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sell</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type tsd-kind-interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><a href="#getOrderbook.getOrderbook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Fetch orderbook (buy/sell orders) between two currency pairs. This checks both sides of the orderbook
by making two <code>order_book</code> requests (with the second reversing takerPays and takerGets). Returned offers are
not normalized in this function, so either currency could be takerGets or takerPays.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">currency1</span>: <a href="../interfaces/BookOfferCurrency.html" class="tsd-signature-type tsd-kind-interface">BookOfferCurrency</a></h5>
<div class="tsd-comment tsd-typography"><p>Specification of one currency involved. (With a currency code and optionally an issuer)</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">currency2</span>: <a href="../interfaces/BookOfferCurrency.html" class="tsd-signature-type tsd-kind-interface">BookOfferCurrency</a></h5>
<div class="tsd-comment tsd-typography"><p>Specification of a second currency involved. (With a currency code and optionally an issuer)</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">ledger_hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">ledger_index</span><span class="tsd-signature-symbol">?: </span><a href="../types/LedgerIndex.html" class="tsd-signature-type tsd-kind-type-alias">LedgerIndex</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">limit</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">taker</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</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></h5>
<div class="tsd-comment tsd-typography"><p>Options allowing the client to specify ledger_index,
ledger_hash, filter by taker, and/or limit number of orders.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ledger_<wbr/>hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Retrieve the orderbook at the ledger with a
given ledger_hash.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ledger_<wbr/>index</span><span class="tsd-signature-symbol">?: </span><a href="../types/LedgerIndex.html" class="tsd-signature-type tsd-kind-type-alias">LedgerIndex</a></h5>
<div class="tsd-comment tsd-typography"><p>Retrieve the orderbook at a given ledger_index.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The limit passed into each book_offers request.
Can return more than this due to two calls being made. Defaults to 20.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">taker</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>Filter orders by taker.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">buy</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type tsd-kind-interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sell</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/BookOffer.html" class="tsd-signature-type tsd-kind-interface">BookOffer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><p>An object containing buy and sell objects.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L970">packages/xrpl/src/client/index.ts:970</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getXrpBalance" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Xrp<wbr/>Balance</span><a href="#getXrpBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getXrpBalance.getXrpBalance-1"><span class="tsd-kind-call-signature">get<wbr/>Xrp<wbr/>Balance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">address</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#getXrpBalance.getXrpBalance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Retrieves the XRP balance of a given account address.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">address</span>: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>The XRP address to retrieve the balance for.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">ledger_hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">ledger_index</span><span class="tsd-signature-symbol">?: </span><a href="../types/LedgerIndex.html" class="tsd-signature-type tsd-kind-type-alias">LedgerIndex</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography"><p>Additional options for fetching the balance (optional).</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ledger_<wbr/>hash</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>The hash of the ledger to retrieve the balance from (optional).</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">ledger_<wbr/>index</span><span class="tsd-signature-symbol">?: </span><a href="../types/LedgerIndex.html" class="tsd-signature-type tsd-kind-type-alias">LedgerIndex</a></h5>
<div class="tsd-comment tsd-typography"><p>The index of the ledger to retrieve the balance from (optional).</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the XRP balance as a number.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-0">wss</span><span class="hl-1">:</span><span class="hl-9">//s.altnet.rippletest.net:51233)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-0">balance</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">getXrpBalance</span><span class="hl-1">(</span><span class="hl-5">&#39;rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">balance</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">disconnect</span><span class="hl-1">()</span><br/><span class="hl-9">/// &#39;200&#39;</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L836">packages/xrpl/src/client/index.ts:836</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Core</h2>
<section class="tsd-panel tsd-member"><a id="autofill" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>autofill</span><a href="#autofill" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="autofill.autofill-1"><span class="tsd-kind-call-signature">autofill</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span>, <span class="tsd-kind-parameter">signersCount</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#autofill.autofill-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Autofills fields in a transaction. This will set <code>Sequence</code>, <code>Fee</code>,
<code>lastLedgerSequence</code> according to the current state of the server this Client
is connected to. It also converts all X-Addresses to classic addresses and
flags interfaces into numbers.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h4>
<div class="tsd-comment tsd-typography"></div></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
<div class="tsd-comment tsd-typography"><p>A <a href="../types/SubmittableTransaction.html" class="tsd-kind-type-alias">SubmittableTransaction</a> in JSON format</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signersCount</span>: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The expected number of signers for this transaction.
Only used for multisigned transactions.</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The autofilled transaction.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><br/><span class="hl-2">async</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">createAndAutofillTransaction</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">transaction</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;Payment&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-5">&#39;rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Destination:</span><span class="hl-1"> </span><span class="hl-5">&#39;r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Amount:</span><span class="hl-1"> </span><span class="hl-5">&#39;10000000&#39;</span><span class="hl-1"> </span><span class="hl-9">// 10 XRP in drops (1/1,000,000th of an XRP)</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">autofilledTransaction</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">autofill</span><span class="hl-1">(</span><span class="hl-0">transaction</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">autofilledTransaction</span><span class="hl-1">)</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">`Failed to autofill transaction: </span><span class="hl-2">${</span><span class="hl-0">error</span><span class="hl-2">}</span><span class="hl-5">`</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">createAndAutofillTransaction</span><span class="hl-1">()</span>
</code><button>Copy</button></pre>
<p>Autofill helps fill in fields which should be included in a transaction, but can be determined automatically
such as <code>LastLedgerSequence</code> and <code>Fee</code>. If you override one of the fields <code>autofill</code> changes, your explicit
values will be used instead. By default, this is done as part of <code>submit</code> and <code>submitAndWait</code> when you pass
in an unsigned transaction along with your wallet to be submitted.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L631">packages/xrpl/src/client/index.ts:631</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="submit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>submit</span><a href="#submit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="submit.submit-1"><span class="tsd-kind-call-signature">submit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type tsd-kind-interface">SubmitResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#submit.submit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Submits a signed/unsigned transaction.
Steps performed on a transaction:</p>
<ol>
<li>Autofill.</li>
<li>Sign &amp; Encode.</li>
<li>Submit.</li>
</ol>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h5>
<div class="tsd-comment tsd-typography"><p>A transaction to autofill, sign &amp; encode, and submit.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">autofill</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">failHard</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<div class="tsd-comment tsd-typography"><p>(Optional) Options used to sign and submit a transaction.</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">autofill</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>If true, autofill a transaction.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">fail<wbr/>Hard</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>If true, and the transaction fails locally, do not retry or relay the transaction to other servers.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a></h5>
<div class="tsd-comment tsd-typography"><p>A wallet to sign a transaction. It must be provided when submitting an unsigned transaction.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/SubmitResponse.html" class="tsd-signature-type tsd-kind-interface">SubmitResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that contains SubmitResponse.</p>
<div class="tsd-comment tsd-typography">
<h4>Throws</h4><p>RippledError if submit request fails.</p>
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1">, </span><span class="hl-3">Wallet</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">wallet</span><span class="hl-1"> = </span><span class="hl-0">Wallet</span><span class="hl-1">.</span><span class="hl-4">generate</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">transaction</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;Payment&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-0">wallet</span><span class="hl-1">.</span><span class="hl-0">classicAddress</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Destination:</span><span class="hl-1"> </span><span class="hl-5">&#39;r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Amount:</span><span class="hl-1"> </span><span class="hl-5">&#39;10000000&#39;</span><span class="hl-1"> </span><span class="hl-9">// 10 XRP in drops (1/1,000,000th of an XRP)</span><br/><span class="hl-1">}</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">submitResponse</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">submit</span><span class="hl-1">(</span><span class="hl-0">transaction</span><span class="hl-1">, { </span><span class="hl-0">wallet</span><span class="hl-1"> })</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">submitResponse</span><span class="hl-1">)</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L695">packages/xrpl/src/client/index.ts:695</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="submitAndWait" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>submit<wbr/>And<wbr/>Wait</span><a href="#submitAndWait" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="submitAndWait.submitAndWait-1"><span class="tsd-kind-call-signature">submit<wbr/>And<wbr/>Wait</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type tsd-kind-interface">TxResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#submitAndWait.submitAndWait-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Asynchronously submits a transaction and verifies that it has been included in a
validated ledger (or has errored/will not be included for some reason).
See <a href="https://xrpl.org/reliable-transaction-submission.html">Reliable Transaction Submission</a>.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a> = <a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">transaction</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
<div class="tsd-comment tsd-typography"><p>A transaction to autofill, sign &amp; encode, and submit.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">autofill</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">failHard</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
<div class="tsd-comment tsd-typography"><p>(Optional) Options used to sign and submit a transaction.</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">autofill</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>If true, autofill a transaction.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">fail<wbr/>Hard</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography"><p>If true, and the transaction fails locally, do not retry or relay the transaction to other servers.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li>
<li class="tsd-parameter">
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">wallet</span><span class="tsd-signature-symbol">?: </span><a href="Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a></h5>
<div class="tsd-comment tsd-typography"><p>A wallet to sign a transaction. It must be provided when submitting an unsigned transaction.</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/TxResponse.html" class="tsd-signature-type tsd-kind-interface">TxResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that contains TxResponse, that will return when the transaction has been validated.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1">, </span><span class="hl-3">Wallet</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><br/><span class="hl-2">async</span><span class="hl-1"> </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">submitTransaction</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">senderWallet</span><span class="hl-1"> = </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">fundWallet</span><span class="hl-1">()</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">recipientWallet</span><span class="hl-1"> = </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">fundWallet</span><span class="hl-1">()</span><br/><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">transaction</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;Payment&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-0">senderWallet</span><span class="hl-1">.</span><span class="hl-0">address</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Destination:</span><span class="hl-1"> </span><span class="hl-0">recipientWallet</span><span class="hl-1">.</span><span class="hl-0">address</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Amount:</span><span class="hl-1"> </span><span class="hl-5">&#39;10&#39;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-6">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">submit</span><span class="hl-1">(</span><span class="hl-0">signedTransaction</span><span class="hl-1">, { </span><span class="hl-0">wallet:</span><span class="hl-1"> </span><span class="hl-0">senderWallet</span><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">result</span><span class="hl-1">)</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">`Failed to submit transaction: </span><span class="hl-2">${</span><span class="hl-0">error</span><span class="hl-2">}</span><span class="hl-5">`</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">submitTransaction</span><span class="hl-1">()</span>
</code><button>Copy</button></pre>
<p>In this example we submit a payment transaction between two newly created testnet accounts.</p>
<p>Under the hood, <code>submit</code> will call <code>client.autofill</code> by default, and because we&#39;ve passed in a <code>Wallet</code> it
Will also sign the transaction for us before submitting the signed transaction binary blob to the ledger.</p>
<p>This is similar to <code>submitAndWait</code> which does all of the above, but also waits to see if the transaction has been validated.</p>
<h4>Throws</h4><p>Connection errors: If the <code>Client</code> object is unable to establish a connection to the specified WebSocket endpoint,
an error will be thrown.</p>
<h4>Throws</h4><p>Transaction errors: If the submitted transaction is invalid or cannot be included in a validated ledger for any
reason, the promise returned by <code>submitAndWait()</code> will be rejected with an error. This could include issues with insufficient
balance, invalid transaction fields, or other issues specific to the transaction being submitted.</p>
<h4>Throws</h4><p>Ledger errors: If the ledger being used to submit the transaction is undergoing maintenance or otherwise unavailable,
an error will be thrown.</p>
<h4>Throws</h4><p>Timeout errors: If the transaction takes longer than the specified timeout period to be included in a validated
ledger, the promise returned by <code>submitAndWait()</code> will be rejected with an error.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L767">packages/xrpl/src/client/index.ts:767</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Faucet</h2>
<section class="tsd-panel tsd-member"><a id="fundWallet" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>fund<wbr/>Wallet</span><a href="#fundWallet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="fundWallet.fundWallet-1"><span class="tsd-kind-call-signature">fund<wbr/>Wallet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">wallet</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">balance</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">wallet</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><a href="#fundWallet.fundWallet-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>The fundWallet() method is used to send an amount of XRP (usually 1000) to a new (randomly generated)
or existing XRP Ledger wallet.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">this</span>: <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">wallet</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a></h5>
<div class="tsd-comment tsd-typography"><p>An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li>
<li>
<h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/FundingOptions.html" class="tsd-signature-type tsd-kind-interface">FundingOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography"><p>See below.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">balance</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">wallet</span><span class="tsd-signature-symbol">: </span><a href="Wallet.html" class="tsd-signature-type tsd-kind-class">Wallet</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A Wallet on the Testnet or Devnet that contains some amount of XRP,
and that wallet&#39;s balance in XRP.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><p>Example 1: Fund a randomly generated wallet
const { Client, Wallet } = require(&#39;xrpl&#39;)</p>
<p>const client = new Client(&#39;wss://s.altnet.rippletest.net:51233&#39;)
await client.connect()
const { balance, wallet } = await client.fundWallet()</p>
<p>Under the hood, this will use <code>Wallet.generate()</code> to create a new random wallet, then ask a testnet faucet
To send it XRP on ledger to make it a real account. If successful, this will return the new account balance in XRP
Along with the Wallet object to track the keys for that account. If you&#39;d like, you can also re-fill an existing
Account by passing in a Wallet you already have.</p>
<pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-0">xrpl</span><span class="hl-1">.</span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&quot;wss://s.altnet.rippletest.net:51233&quot;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">wallet</span><span class="hl-1">, </span><span class="hl-3">balance</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">fundWallet</span><span class="hl-1">()</span>
</code><button>Copy</button></pre>
<p>Example 2: Fund wallet using a custom faucet host and known wallet address</p>
<p><code>fundWallet</code> will try to infer the url of a faucet API from the network your client is connected to.
There are hardcoded default faucets for popular test networks like testnet and devnet.
However, if you&#39;re working with a newer or more obscure network, you may have to specify the faucetHost
And faucetPath so <code>fundWallet</code> can ask that faucet to fund your wallet.</p>
<pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">newWallet</span><span class="hl-1"> = </span><span class="hl-0">Wallet</span><span class="hl-1">.</span><span class="hl-4">generate</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">balance</span><span class="hl-1">, </span><span class="hl-3">wallet</span><span class="hl-1"> } = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">fundWallet</span><span class="hl-1">(</span><span class="hl-0">newWallet</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-0">amount:</span><span class="hl-1"> </span><span class="hl-5">&#39;10&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">faucetHost:</span><span class="hl-1"> </span><span class="hl-5">&#39;https://custom-faucet.example.com&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">faucetPath:</span><span class="hl-1"> </span><span class="hl-5">&#39;/accounts&#39;</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">`Sent 10 XRP to wallet: </span><span class="hl-2">${</span><span class="hl-0">address</span><span class="hl-2">}</span><span class="hl-5"> from the given faucet. Resulting balance: </span><span class="hl-2">${</span><span class="hl-0">balance</span><span class="hl-2">}</span><span class="hl-5"> XRP`</span><span class="hl-1">)</span><br/><span class="hl-1"> } </span><span class="hl-6">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">error</span><span class="hl-1">(</span><span class="hl-5">`Failed to fund wallet: </span><span class="hl-2">${</span><span class="hl-0">error</span><span class="hl-2">}</span><span class="hl-5">`</span><span class="hl-1">)</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code><button>Copy</button></pre>
<h4>Throws</h4><p>When either Client isn&#39;t connected or unable to fund wallet address.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L1101">packages/xrpl/src/client/index.ts:1101</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Fee</h2>
<section class="tsd-panel tsd-member"><a id="feeCushion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</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>
<div class="tsd-comment tsd-typography"><p>Factor to multiply estimated fee by to provide a cushion in case the
required fee rises during submission of a transaction. Defaults to 1.2.</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/a58bf2663/packages/xrpl/src/client/index.ts#L179">packages/xrpl/src/client/index.ts:179</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-flagReadonly">Readonly</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>
<div class="tsd-comment tsd-typography"><p>Maximum transaction cost to allow, in decimal XRP. Must be a string-encoded
number. Defaults to &#39;2&#39;.</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/a58bf2663/packages/xrpl/src/client/index.ts#L187">packages/xrpl/src/client/index.ts:187</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Network</h2>
<section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><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>
<ul class="tsd-signatures">
<li class="tsd-signature" id="url.url-1"><span class="tsd-signature-symbol">get</span> url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get the url that the client is connected to.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The URL of the server this client is connected to.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L285">packages/xrpl/src/client/index.ts:285</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="connect.connect-1"><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#connect.connect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Tells the Client instance to connect to its rippled server.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with a void value when a connection is established.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><p>Client.connect() establishes a connection between a Client object and the server.</p>
<pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-9">// do something with the client</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">disconnect</span><span class="hl-1">()</span>
</code><button>Copy</button></pre>
<p>If you open a client connection, be sure to close it with <code>await client.disconnect()</code>
before exiting your application.</p>
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-9">// do something with the client</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">disconnect</span><span class="hl-1">()</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L530">packages/xrpl/src/client/index.ts:530</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="disconnect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>disconnect</span><a href="#disconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="disconnect.disconnect-1"><span class="tsd-kind-call-signature">disconnect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disconnect.disconnect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Disconnects the XRPL client from the server and cancels all pending requests and subscriptions. Call when
you want to disconnect the client from the server, such as when you&#39;re finished using the client or when you
need to switch to a different server.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with a void value when a connection is destroyed.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><p>To use the disconnect() method, you first need to create a new Client object and connect it to a server:</p>
<pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-9">// do something with the client</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">disconnect</span><span class="hl-1">()</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L557">packages/xrpl/src/client/index.ts:557</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="isConnected" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Connected</span><a href="#isConnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="isConnected.isConnected-1"><span class="tsd-kind-call-signature">is<wbr/>Connected</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isConnected.isConnected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Checks if the Client instance is connected to its rippled server.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the client instance is connected.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">isConnected</span><span class="hl-1">())</span><br/><span class="hl-9">// true</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">disconnect</span><span class="hl-1">()</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">isConnected</span><span class="hl-1">())</span><br/><span class="hl-9">// false</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L582">packages/xrpl/src/client/index.ts:582</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="on.on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Event handler for subscription streams.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">EventTypes</span></h4></li>
<li>
<h4><span class="tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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> = <span class="tsd-signature-type ">OnEventToListenerMap</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
<div class="tsd-comment tsd-typography"><p>Name of the event. Only forwards streams.</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5>
<div class="tsd-comment tsd-typography"><p>Function to run on event.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h4><p>This, because it inherits from EventEmitter.</p>
<ul>
<li></li>
</ul>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><br/><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-5">&#39;transaction&#39;</span><span class="hl-1">, (</span><span class="hl-0">tx</span><span class="hl-1">: </span><span class="hl-10">TransactionStream</span><span class="hl-1">) </span><span class="hl-2">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-5">&quot;Received Transaction&quot;</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">tx</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">connect</span><span class="hl-1">()</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">api</span><span class="hl-1">.</span><span class="hl-4">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">&#39;subscribe&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">streams:</span><span class="hl-1"> [</span><span class="hl-5">&#39;transactions_proposed&#39;</span><span class="hl-1">]</span><br/><span class="hl-1">})</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<p>Overrides EventEmitter.on</p>
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L387">packages/xrpl/src/client/index.ts:387</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="request" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="request.request-1"><span class="tsd-kind-call-signature">request</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#request.request-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Makes a request to the client with the given command and
additional request body parameters.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol"> extends </span><a href="../types/Request.html" class="tsd-signature-type tsd-kind-type-alias">Request</a></h4></li>
<li>
<h4><span class="tsd-kind-type-parameter">T</span> = <a href="../types/RequestResponseMap.html" class="tsd-signature-type tsd-kind-type-alias">RequestResponseMap</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">req</span>: <span class="tsd-signature-type tsd-kind-type-parameter">R</span></h5>
<div class="tsd-comment tsd-typography"><p>Request to send to the server.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The response from the server.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">&#39;account_info&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">account:</span><span class="hl-1"> </span><span class="hl-5">&#39;r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">})</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">response</span><span class="hl-1">)</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L307">packages/xrpl/src/client/index.ts:307</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="requestAll" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>request<wbr/>All</span><a href="#requestAll" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="requestAll.requestAll-1"><span class="tsd-kind-call-signature">request<wbr/>All</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span>, <span class="tsd-kind-parameter">collect</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#requestAll.requestAll-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Makes multiple paged requests to the client to return a given number of
resources. Multiple paged requests will be made until the <code>limit</code>
number of resources is reached (if no <code>limit</code> is provided, a single request
will be made).</p>
<p>If the command is unknown, an additional <code>collect</code> property is required to
know which response key contains the array of resources.</p>
<p>NOTE: This command is used by existing methods and is not recommended for
general use. Instead, use rippled&#39;s built-in pagination and make multiple
requests as needed.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="../types/MarkerRequest.html" class="tsd-signature-type tsd-kind-type-alias">MarkerRequest</a></h4></li>
<li>
<h4><span class="tsd-kind-type-parameter">U</span> = <a href="../types/RequestAllResponseMap.html" class="tsd-signature-type tsd-kind-type-alias">RequestAllResponseMap</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
<div class="tsd-comment tsd-typography"><p>The initial request to send to the server.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">collect</span>: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>(Optional) the param to use to collect the array of resources (only needed if command is unknown).</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The array of all responses.</p>
<div class="tsd-comment tsd-typography">
<h4>Throws</h4><p>ValidationError if there is no collection key (either from a known command or for the unknown command).</p>
<h4>Example</h4><pre><code class="language-ts"><span class="hl-9">// Request all ledger data pages</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">allResponses</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">requestAll</span><span class="hl-1">({ </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">&#39;ledger_data&#39;</span><span class="hl-1"> });</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">allResponses</span><span class="hl-1">);</span>
</code><button>Copy</button></pre>
<h4>Example</h4><pre><code class="language-ts"><span class="hl-9">// Request all transaction data pages</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">allResponses</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">requestAll</span><span class="hl-1">({ </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">&#39;transaction_data&#39;</span><span class="hl-1"> });</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">allResponses</span><span class="hl-1">);</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L425">packages/xrpl/src/client/index.ts:425</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="requestNextPage" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>request<wbr/>Next<wbr/>Page</span><a href="#requestNextPage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="requestNextPage.requestNextPage-1"><span class="tsd-kind-call-signature">request<wbr/>Next<wbr/>Page</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">req</span>, <span class="tsd-kind-parameter">resp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">RequestNextPageReturnMap</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#requestNextPage.requestNextPage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Requests the next page of data.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">RequestNextPageType</span></h4></li>
<li>
<h4><span class="tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/AccountChannelsResponse.html" class="tsd-signature-type tsd-kind-interface">AccountChannelsResponse</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/AccountLinesResponse.html" class="tsd-signature-type tsd-kind-interface">AccountLinesResponse</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/AccountObjectsResponse.html" class="tsd-signature-type tsd-kind-interface">AccountObjectsResponse</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/AccountOffersResponse.html" class="tsd-signature-type tsd-kind-interface">AccountOffersResponse</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/AccountTxResponse.html" class="tsd-signature-type tsd-kind-interface">AccountTxResponse</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerDataResponse.html" class="tsd-signature-type tsd-kind-interface">LedgerDataResponse</a></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">req</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
<div class="tsd-comment tsd-typography"><p>Request to send.</p>
</div></li>
<li>
<h5><span class="tsd-kind-parameter">resp</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5>
<div class="tsd-comment tsd-typography"><p>Response with the marker to use in the request.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">RequestNextPageReturnMap</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The response with the next page of data.</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">response</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">request</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">&#39;account_tx&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">account:</span><span class="hl-1"> </span><span class="hl-5">&#39;r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">})</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">response</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">nextResponse</span><span class="hl-1"> = </span><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">requestNextPage</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">command:</span><span class="hl-1"> </span><span class="hl-5">&#39;account_tx&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">account:</span><span class="hl-1"> </span><span class="hl-5">&#39;r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">},</span><br/><span class="hl-0">response</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">nextResponse</span><span class="hl-1">)</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L348">packages/xrpl/src/client/index.ts:348</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Other</h2>
<section class="tsd-panel tsd-member"><a id="buildVersion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>build<wbr/>Version</span><a href="#buildVersion" 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">build<wbr/>Version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Rippled Version used by the server this client is connected to</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/a58bf2663/packages/xrpl/src/client/index.ts#L199">packages/xrpl/src/client/index.ts:199</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="connection" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>connection</span><a href="#connection" 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</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Connection</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L171">packages/xrpl/src/client/index.ts:171</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="networkID" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>networkID</span><a href="#networkID" 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">networkID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>Network ID of the server this client is connected to</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/a58bf2663/packages/xrpl/src/client/index.ts#L193">packages/xrpl/src/client/index.ts:193</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prefixed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>prefixed</span><a href="#prefixed" 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">prefixed</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">boolean</span></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.prefixed</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:9</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-1"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a><a href="#addListener.addListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">EventTypes</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
<li>
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-is-external">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h4><aside class="tsd-sources">
<p>Inherited from EventEmitter.addListener</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:45</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="emit.emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Calls each of the listeners registered for a given event.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">EventTypes</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.emit</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:32</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>event<wbr/>Names</span><a href="#eventNames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="eventNames.eventNames-1"><span class="tsd-kind-call-signature">event<wbr/>Names</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">EventTypes</span><span class="tsd-signature-symbol">[]</span><a href="#eventNames.eventNames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Return an array listing the events for which the emitter has registered
listeners.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">EventTypes</span><span class="tsd-signature-symbol">[]</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.eventNames</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:15</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getServerInfo" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Server<wbr/>Info</span><a href="#getServerInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="getServerInfo.getServerInfo-1"><span class="tsd-kind-call-signature">get<wbr/>Server<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#getServerInfo.getServerInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Get networkID and buildVersion from server_info</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-2">const</span><span class="hl-1"> { </span><span class="hl-3">Client</span><span class="hl-1"> } = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl&#39;</span><span class="hl-1">)</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">client</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">&#39;wss://s.altnet.rippletest.net:51233&#39;</span><span class="hl-1">)</span><br/><span class="hl-6">await</span><span class="hl-1"> </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-4">getServerInfo</span><span class="hl-1">()</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-0">networkID</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-0">buildVersion</span><span class="hl-1">)</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L489">packages/xrpl/src/client/index.ts:489</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="listenerCount.listenerCount-1"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount.listenerCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Return the number of listeners listening to a given event.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">EventTypes</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.listenerCount</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:27</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Return the listeners registered for a given event.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">EventTypes</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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><span class="tsd-signature-symbol">[]</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.listeners</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:20</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="off.off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">once</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">EventTypes</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><code class="tsd-tag ts-flagOptional">Optional</code>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-is-external">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">once</span>: <span class="tsd-signature-type">boolean</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h4><aside class="tsd-sources">
<p>Inherited from EventEmitter.off</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:69</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="once.once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a><a href="#once.once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Add a one-time listener for a given event.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">EventTypes</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
<li>
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-is-external">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.once</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:54</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="prepareTransaction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>prepare<wbr/>Transaction</span><a href="#prepareTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="prepareTransaction.prepareTransaction-1"><span class="tsd-kind-call-signature">prepare<wbr/>Transaction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">transaction</span>, <span class="tsd-kind-parameter">signersCount</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a><span class="tsd-signature-symbol">&gt;</span><a href="#prepareTransaction.prepareTransaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Deprecated: Use autofill instead, provided for users familiar with v1</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">transaction</span>: <a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a></h5>
<div class="tsd-comment tsd-typography"><p>A <a href="../types/Transaction.html" class="tsd-kind-type-alias">Transaction</a> in JSON format</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">signersCount</span>: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>The expected number of signers for this transaction.
Only used for multisigned transactions.</p>
</div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/SubmittableTransaction.html" class="tsd-signature-type tsd-kind-type-alias">SubmittableTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography">
<h4>Deprecated</h4><p>Use autofill instead, provided for users familiar with v1</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/a58bf2663/packages/xrpl/src/client/index.ts#L808">packages/xrpl/src/client/index.ts:808</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="removeAllListeners.removeAllListeners-1"><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a><a href="#removeAllListeners.removeAllListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Remove all listeners, or those of the specified event.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">EventTypes</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.removeAllListeners</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:79</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>remove<wbr/>Listener</span><a href="#removeListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">once</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a><a href="#removeListener.removeListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Remove the listeners of a given event.</p>
</div>
<section class="tsd-panel">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameter-list">
<li>
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">EventTypes</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5><code class="tsd-tag ts-flagOptional">Optional</code>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-is-external">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">once</span>: <span class="tsd-signature-type">boolean</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Client.html" class="tsd-signature-type tsd-kind-class">Client</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from EventEmitter.removeListener</p>
<ul>
<li>Defined in node_modules/eventemitter3/index.d.ts:63</li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4><form>
<ul id="tsd-filter-options">
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
<li><a href="#getBalances" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Balances</span></a></li>
<li><a href="#getLedgerIndex" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Ledger<wbr/>Index</span></a></li>
<li><a href="#getOrderbook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Orderbook</span></a></li>
<li><a href="#getXrpBalance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Xrp<wbr/>Balance</span></a></li>
<li><a href="#autofill" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>autofill</span></a></li>
<li><a href="#submit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>submit</span></a></li>
<li><a href="#submitAndWait" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>submit<wbr/>And<wbr/>Wait</span></a></li>
<li><a href="#fundWallet" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fund<wbr/>Wallet</span></a></li>
<li><a href="#feeCushion" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>fee<wbr/>Cushion</span></a></li>
<li><a href="#maxFeeXRP" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max<wbr/>FeeXRP</span></a></li>
<li><a href="#url" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>url</span></a></li>
<li><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>connect</span></a></li>
<li><a href="#disconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disconnect</span></a></li>
<li><a href="#isConnected" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Connected</span></a></li>
<li><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
<li><a href="#request" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request</span></a></li>
<li><a href="#requestAll" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request<wbr/>All</span></a></li>
<li><a href="#requestNextPage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>request<wbr/>Next<wbr/>Page</span></a></li>
<li><a href="#buildVersion" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>build<wbr/>Version</span></a></li>
<li><a href="#connection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>connection</span></a></li>
<li><a href="#networkID" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>networkID</span></a></li>
<li><a href="#prefixed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prefixed</span></a></li>
<li><a href="#addListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Listener</span></a></li>
<li><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a></li>
<li><a href="#eventNames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>event<wbr/>Names</span></a></li>
<li><a href="#getServerInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Server<wbr/>Info</span></a></li>
<li><a href="#listenerCount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a></li>
<li><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a></li>
<li><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li>
<li><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a></li>
<li><a href="#prepareTransaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepare<wbr/>Transaction</span></a></li>
<li><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a></li>
<li><a href="#removeListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>xrpl</span></a>
<ul class="tsd-small-nested-navigation">
<li><a href="../modules/LedgerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>Ledger<wbr/>Entry</span></a></li>
<li><a href="../enums/AMMDepositFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>AMMDeposit<wbr/>Flags</span></a></li>
<li><a href="../enums/AMMWithdrawFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>AMMWithdraw<wbr/>Flags</span></a></li>
<li><a href="../enums/AccountSetAsfFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Account<wbr/>Set<wbr/>Asf<wbr/>Flags</span></a></li>
<li><a href="../enums/AccountSetTfFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Account<wbr/>Set<wbr/>Tf<wbr/>Flags</span></a></li>
<li><a href="../enums/ECDSA.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>ECDSA</span></a></li>
<li><a href="../enums/EnableAmendmentFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Enable<wbr/>Amendment<wbr/>Flags</span></a></li>
<li><a href="../enums/NFTokenCreateOfferFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>NFToken<wbr/>Create<wbr/>Offer<wbr/>Flags</span></a></li>
<li><a href="../enums/NFTokenMintFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>NFToken<wbr/>Mint<wbr/>Flags</span></a></li>
<li><a href="../enums/OfferCreateFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Offer<wbr/>Create<wbr/>Flags</span></a></li>
<li><a href="../enums/PaymentChannelClaimFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags</span></a></li>
<li><a href="../enums/PaymentFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Payment<wbr/>Flags</span></a></li>
<li><a href="../enums/TrustSetFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Trust<wbr/>Set<wbr/>Flags</span></a></li>
<li><a href="../enums/XChainModifyBridgeFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>XChain<wbr/>Modify<wbr/>Bridge<wbr/>Flags</span></a></li>
<li><a href="Client.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Client</span></a></li>
<li><a href="ConnectionError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Connection<wbr/>Error</span></a></li>
<li><a href="DisconnectedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Disconnected<wbr/>Error</span></a></li>
<li><a href="NotConnectedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Not<wbr/>Connected<wbr/>Error</span></a></li>
<li><a href="NotFoundError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Not<wbr/>Found<wbr/>Error</span></a></li>
<li><a href="ResponseFormatError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Response<wbr/>Format<wbr/>Error</span></a></li>
<li><a href="RippledError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rippled<wbr/>Error</span></a></li>
<li><a href="RippledNotInitializedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rippled<wbr/>Not<wbr/>Initialized<wbr/>Error</span></a></li>
<li><a href="TimeoutError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Timeout<wbr/>Error</span></a></li>
<li><a href="UnexpectedError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Unexpected<wbr/>Error</span></a></li>
<li><a href="ValidationError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Validation<wbr/>Error</span></a></li>
<li><a href="Wallet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Wallet</span></a></li>
<li><a href="XRPLFaucetError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>XRPLFaucet<wbr/>Error</span></a></li>
<li><a href="XrplError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Xrpl<wbr/>Error</span></a></li>
<li><a href="../interfaces/AMMBid.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>AMMBid</span></a></li>
<li><a href="../interfaces/AMMCreate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMCreate</span></a></li>
<li><a href="../interfaces/AMMDelete.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMDelete</span></a></li>
<li><a href="../interfaces/AMMDeposit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMDeposit</span></a></li>
<li><a href="../interfaces/AMMDepositFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMDeposit<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/AMMInfoRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMInfo<wbr/>Request</span></a></li>
<li><a href="../interfaces/AMMInfoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMInfo<wbr/>Response</span></a></li>
<li><a href="../interfaces/AMMVote.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMVote</span></a></li>
<li><a href="../interfaces/AMMWithdraw.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMWithdraw</span></a></li>
<li><a href="../interfaces/AMMWithdrawFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AMMWithdraw<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/AccountChannelsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Channels<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountChannelsResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Channels<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountCurrenciesRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Currencies<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountCurrenciesResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Currencies<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountDelete.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Delete</span></a></li>
<li><a href="../interfaces/AccountInfoAccountFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Info<wbr/>Account<wbr/>Flags</span></a></li>
<li><a href="../interfaces/AccountInfoRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Info<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountInfoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Info<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountLinesRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Lines<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountLinesResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Lines<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountLinesTrustline.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Lines<wbr/>Trustline</span></a></li>
<li><a href="../interfaces/AccountNFToken.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AccountNFToken</span></a></li>
<li><a href="../interfaces/AccountNFTsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AccountNFTs<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountNFTsResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>AccountNFTs<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountObjectsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Objects<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountObjectsResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Objects<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountOffer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Offer</span></a></li>
<li><a href="../interfaces/AccountOffersRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Offers<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountOffersResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Offers<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountQueueData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Queue<wbr/>Data</span></a></li>
<li><a href="../interfaces/AccountQueueTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Queue<wbr/>Transaction</span></a></li>
<li><a href="../interfaces/AccountSet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Set</span></a></li>
<li><a href="../interfaces/AccountSetFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Set<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/AccountTxRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Tx<wbr/>Request</span></a></li>
<li><a href="../interfaces/AccountTxResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Tx<wbr/>Response</span></a></li>
<li><a href="../interfaces/AccountTxTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Account<wbr/>Tx<wbr/>Transaction</span></a></li>
<li><a href="../interfaces/AuthAccount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Auth<wbr/>Account</span></a></li>
<li><a href="../interfaces/Balance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Balance</span></a></li>
<li><a href="../interfaces/BaseRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Request</span></a></li>
<li><a href="../interfaces/BaseResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Response</span></a></li>
<li><a href="../interfaces/BaseTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Base<wbr/>Transaction</span></a></li>
<li><a href="../interfaces/BookOffer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Book<wbr/>Offer</span></a></li>
<li><a href="../interfaces/BookOfferCurrency.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Book<wbr/>Offer<wbr/>Currency</span></a></li>
<li><a href="../interfaces/BookOffersRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Book<wbr/>Offers<wbr/>Request</span></a></li>
<li><a href="../interfaces/BookOffersResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Book<wbr/>Offers<wbr/>Response</span></a></li>
<li><a href="../interfaces/Channel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Channel</span></a></li>
<li><a href="../interfaces/ChannelVerifyRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Channel<wbr/>Verify<wbr/>Request</span></a></li>
<li><a href="../interfaces/ChannelVerifyResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Channel<wbr/>Verify<wbr/>Response</span></a></li>
<li><a href="../interfaces/CheckCancel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Check<wbr/>Cancel</span></a></li>
<li><a href="../interfaces/CheckCash.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Check<wbr/>Cash</span></a></li>
<li><a href="../interfaces/CheckCreate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Check<wbr/>Create</span></a></li>
<li><a href="../interfaces/Clawback.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Clawback</span></a></li>
<li><a href="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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>
<li><a href="../interfaces/DepositPreauth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Preauth</span></a></li>
<li><a href="../interfaces/EnableAmendment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Enable<wbr/>Amendment</span></a></li>
<li><a href="../interfaces/ErrorResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Error<wbr/>Response</span></a></li>
<li><a href="../interfaces/EscrowCancel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Escrow<wbr/>Cancel</span></a></li>
<li><a href="../interfaces/EscrowCreate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Escrow<wbr/>Create</span></a></li>
<li><a href="../interfaces/EscrowFinish.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Escrow<wbr/>Finish</span></a></li>
<li><a href="../interfaces/FeeRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Fee<wbr/>Request</span></a></li>
<li><a href="../interfaces/FeeResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Fee<wbr/>Response</span></a></li>
<li><a href="../interfaces/FundingOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Funding<wbr/>Options</span></a></li>
<li><a href="../interfaces/GatewayBalance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Gateway<wbr/>Balance</span></a></li>
<li><a href="../interfaces/GatewayBalancesRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Gateway<wbr/>Balances<wbr/>Request</span></a></li>
<li><a href="../interfaces/GatewayBalancesResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Gateway<wbr/>Balances<wbr/>Response</span></a></li>
<li><a href="../interfaces/IssuedCurrency.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Issued<wbr/>Currency</span></a></li>
<li><a href="../interfaces/IssuedCurrencyAmount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Issued<wbr/>Currency<wbr/>Amount</span></a></li>
<li><a href="../interfaces/JobType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Job<wbr/>Type</span></a></li>
<li><a href="../interfaces/LedgerBinary.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Binary</span></a></li>
<li><a href="../interfaces/LedgerClosedRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Closed<wbr/>Request</span></a></li>
<li><a href="../interfaces/LedgerClosedResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Closed<wbr/>Response</span></a></li>
<li><a href="../interfaces/LedgerCurrentRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Current<wbr/>Request</span></a></li>
<li><a href="../interfaces/LedgerCurrentResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Current<wbr/>Response</span></a></li>
<li><a href="../interfaces/LedgerDataBinaryLedgerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Data<wbr/>Binary<wbr/>Ledger<wbr/>Entry</span></a></li>
<li><a href="../interfaces/LedgerDataRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Data<wbr/>Request</span></a></li>
<li><a href="../interfaces/LedgerDataResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Data<wbr/>Response</span></a></li>
<li><a href="../interfaces/LedgerEntryRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Entry<wbr/>Request</span></a></li>
<li><a href="../interfaces/LedgerEntryResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Entry<wbr/>Response</span></a></li>
<li><a href="../interfaces/LedgerModifiedOfferCreateTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Modified<wbr/>Offer<wbr/>Create<wbr/>Transaction</span></a></li>
<li><a href="../interfaces/LedgerQueueData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Queue<wbr/>Data</span></a></li>
<li><a href="../interfaces/LedgerRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Request</span></a></li>
<li><a href="../interfaces/LedgerResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Response</span></a></li>
<li><a href="../interfaces/LedgerStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Stream</span></a></li>
<li><a href="../interfaces/LedgerStreamResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ledger<wbr/>Stream<wbr/>Response</span></a></li>
<li><a href="../interfaces/ManifestRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Manifest<wbr/>Request</span></a></li>
<li><a href="../interfaces/ManifestResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Manifest<wbr/>Response</span></a></li>
<li><a href="../interfaces/Memo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Memo</span></a></li>
<li><a href="../interfaces/ModifiedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Modified<wbr/>Node</span></a></li>
<li><a href="../interfaces/NFTBuyOffersRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTBuy<wbr/>Offers<wbr/>Request</span></a></li>
<li><a href="../interfaces/NFTBuyOffersResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTBuy<wbr/>Offers<wbr/>Response</span></a></li>
<li><a href="../interfaces/NFTHistoryRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTHistory<wbr/>Request</span></a></li>
<li><a href="../interfaces/NFTHistoryResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTHistory<wbr/>Response</span></a></li>
<li><a href="../interfaces/NFTHistoryTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTHistory<wbr/>Transaction</span></a></li>
<li><a href="../interfaces/NFTInfoRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTInfo<wbr/>Request</span></a></li>
<li><a href="../interfaces/NFTInfoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTInfo<wbr/>Response</span></a></li>
<li><a href="../interfaces/NFTOffer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTOffer</span></a></li>
<li><a href="../interfaces/NFTSellOffersRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTSell<wbr/>Offers<wbr/>Request</span></a></li>
<li><a href="../interfaces/NFTSellOffersResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFTSell<wbr/>Offers<wbr/>Response</span></a></li>
<li><a href="../interfaces/NFToken.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken</span></a></li>
<li><a href="../interfaces/NFTokenAcceptOffer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken<wbr/>Accept<wbr/>Offer</span></a></li>
<li><a href="../interfaces/NFTokenBurn.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken<wbr/>Burn</span></a></li>
<li><a href="../interfaces/NFTokenCancelOffer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken<wbr/>Cancel<wbr/>Offer</span></a></li>
<li><a href="../interfaces/NFTokenCreateOffer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken<wbr/>Create<wbr/>Offer</span></a></li>
<li><a href="../interfaces/NFTokenCreateOfferFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken<wbr/>Create<wbr/>Offer<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/NFTokenMint.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken<wbr/>Mint</span></a></li>
<li><a href="../interfaces/NFTokenMintFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>NFToken<wbr/>Mint<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/NoRippleCheckRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>No<wbr/>Ripple<wbr/>Check<wbr/>Request</span></a></li>
<li><a href="../interfaces/NoRippleCheckResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>No<wbr/>Ripple<wbr/>Check<wbr/>Response</span></a></li>
<li><a href="../interfaces/OfferCancel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Offer<wbr/>Cancel</span></a></li>
<li><a href="../interfaces/OfferCreate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Offer<wbr/>Create</span></a></li>
<li><a href="../interfaces/OfferCreateFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Offer<wbr/>Create<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/OrderBookStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Order<wbr/>Book<wbr/>Stream</span></a></li>
<li><a href="../interfaces/PathFindCloseRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Path<wbr/>Find<wbr/>Close<wbr/>Request</span></a></li>
<li><a href="../interfaces/PathFindCreateRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Path<wbr/>Find<wbr/>Create<wbr/>Request</span></a></li>
<li><a href="../interfaces/PathFindPathOption.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Path<wbr/>Find<wbr/>Path<wbr/>Option</span></a></li>
<li><a href="../interfaces/PathFindResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Path<wbr/>Find<wbr/>Response</span></a></li>
<li><a href="../interfaces/PathFindStatusRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Path<wbr/>Find<wbr/>Status<wbr/>Request</span></a></li>
<li><a href="../interfaces/PathFindStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Path<wbr/>Find<wbr/>Stream</span></a></li>
<li><a href="../interfaces/PathStep.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Path<wbr/>Step</span></a></li>
<li><a href="../interfaces/Payment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Payment</span></a></li>
<li><a href="../interfaces/PaymentChannelClaim.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Payment<wbr/>Channel<wbr/>Claim</span></a></li>
<li><a href="../interfaces/PaymentChannelClaimFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/PaymentChannelCreate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Payment<wbr/>Channel<wbr/>Create</span></a></li>
<li><a href="../interfaces/PaymentChannelFund.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Payment<wbr/>Channel<wbr/>Fund</span></a></li>
<li><a href="../interfaces/PaymentFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Payment<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/PeerStatusStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Peer<wbr/>Status<wbr/>Stream</span></a></li>
<li><a href="../interfaces/PingRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ping<wbr/>Request</span></a></li>
<li><a href="../interfaces/PingResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ping<wbr/>Response</span></a></li>
<li><a href="../interfaces/RandomRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Random<wbr/>Request</span></a></li>
<li><a href="../interfaces/RandomResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Random<wbr/>Response</span></a></li>
<li><a href="../interfaces/ResponseOnlyTxInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Response<wbr/>Only<wbr/>Tx<wbr/>Info</span></a></li>
<li><a href="../interfaces/ResponseWarning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Response<wbr/>Warning</span></a></li>
<li><a href="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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="../interfaces/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>
<li><a href="../interfaces/ServerStateResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>State<wbr/>Response</span></a></li>
<li><a href="../interfaces/SetFeePostAmendment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Set<wbr/>Fee<wbr/>Post<wbr/>Amendment</span></a></li>
<li><a href="../interfaces/SetFeePreAmendment.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Set<wbr/>Fee<wbr/>Pre<wbr/>Amendment</span></a></li>
<li><a href="../interfaces/SetRegularKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Set<wbr/>Regular<wbr/>Key</span></a></li>
<li><a href="../interfaces/Signer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Signer</span></a></li>
<li><a href="../interfaces/SignerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Signer<wbr/>Entry</span></a></li>
<li><a href="../interfaces/SignerListSet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Signer<wbr/>List<wbr/>Set</span></a></li>
<li><a href="../interfaces/SourceCurrencyAmount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Source<wbr/>Currency<wbr/>Amount</span></a></li>
<li><a href="../interfaces/StateAccounting.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>State<wbr/>Accounting</span></a></li>
<li><a href="../interfaces/SubmitMultisignedRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Submit<wbr/>Multisigned<wbr/>Request</span></a></li>
<li><a href="../interfaces/SubmitMultisignedResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Submit<wbr/>Multisigned<wbr/>Response</span></a></li>
<li><a href="../interfaces/SubmitRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Submit<wbr/>Request</span></a></li>
<li><a href="../interfaces/SubmitResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Submit<wbr/>Response</span></a></li>
<li><a href="../interfaces/SubscribeBook.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Subscribe<wbr/>Book</span></a></li>
<li><a href="../interfaces/SubscribeRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Subscribe<wbr/>Request</span></a></li>
<li><a href="../interfaces/SubscribeResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Subscribe<wbr/>Response</span></a></li>
<li><a href="../interfaces/TicketCreate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ticket<wbr/>Create</span></a></li>
<li><a href="../interfaces/TransactionAndMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>And<wbr/>Metadata</span></a></li>
<li><a href="../interfaces/TransactionEntryRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Entry<wbr/>Request</span></a></li>
<li><a href="../interfaces/TransactionEntryResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Entry<wbr/>Response</span></a></li>
<li><a href="../interfaces/TransactionMetadataBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Metadata<wbr/>Base</span></a></li>
<li><a href="../interfaces/TransactionStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Transaction<wbr/>Stream</span></a></li>
<li><a href="../interfaces/TrustSet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Trust<wbr/>Set</span></a></li>
<li><a href="../interfaces/TrustSetFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Trust<wbr/>Set<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/TxRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tx<wbr/>Request</span></a></li>
<li><a href="../interfaces/TxResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tx<wbr/>Response</span></a></li>
<li><a href="../interfaces/UNLModify.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>UNLModify</span></a></li>
<li><a href="../interfaces/UnsubscribeBook.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Unsubscribe<wbr/>Book</span></a></li>
<li><a href="../interfaces/UnsubscribeRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Unsubscribe<wbr/>Request</span></a></li>
<li><a href="../interfaces/UnsubscribeResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Unsubscribe<wbr/>Response</span></a></li>
<li><a href="../interfaces/ValidationStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Validation<wbr/>Stream</span></a></li>
<li><a href="../interfaces/XChainAccountCreateCommit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Account<wbr/>Create<wbr/>Commit</span></a></li>
<li><a href="../interfaces/XChainAddAccountCreateAttestation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Add<wbr/>Account<wbr/>Create<wbr/>Attestation</span></a></li>
<li><a href="../interfaces/XChainAddClaimAttestation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Add<wbr/>Claim<wbr/>Attestation</span></a></li>
<li><a href="../interfaces/XChainBridge.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Bridge</span></a></li>
<li><a href="../interfaces/XChainClaim.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Claim</span></a></li>
<li><a href="../interfaces/XChainCommit.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Commit</span></a></li>
<li><a href="../interfaces/XChainCreateBridge.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Create<wbr/>Bridge</span></a></li>
<li><a href="../interfaces/XChainCreateClaimID.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Create<wbr/>ClaimID</span></a></li>
<li><a href="../interfaces/XChainModifyBridge.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Modify<wbr/>Bridge</span></a></li>
<li><a href="../interfaces/XChainModifyBridgeFlagsInterface.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XChain<wbr/>Modify<wbr/>Bridge<wbr/>Flags<wbr/>Interface</span></a></li>
<li><a href="../interfaces/XRP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>XRP</span></a></li>
<li><a href="../types/AccountObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Account<wbr/>Object</span></a></li>
<li><a href="../types/AccountObjectType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Account<wbr/>Object<wbr/>Type</span></a></li>
<li><a href="../types/Amount.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Amount</span></a></li>
<li><a href="../types/BooksSnapshot.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Books<wbr/>Snapshot</span></a></li>
<li><a href="../types/Currency.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Currency</span></a></li>
<li><a href="../types/LedgerDataLabeledLedgerEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Data<wbr/>Labeled<wbr/>Ledger<wbr/>Entry</span></a></li>
<li><a href="../types/LedgerDataLedgerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Data<wbr/>Ledger<wbr/>State</span></a></li>
<li><a href="../types/LedgerIndex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Ledger<wbr/>Index</span></a></li>
<li><a href="../types/MarkerRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Marker<wbr/>Request</span></a></li>
<li><a href="../types/MarkerResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Marker<wbr/>Response</span></a></li>
<li><a href="../types/Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Node</span></a></li>
<li><a href="../types/Path.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Path</span></a></li>
<li><a href="../types/PathFindRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Path<wbr/>Find<wbr/>Request</span></a></li>
<li><a href="../types/PseudoTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pseudo<wbr/>Transaction</span></a></li>
<li><a href="../types/Request.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Request</span></a></li>
<li><a href="../types/RequestAllResponseMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Request<wbr/>All<wbr/>Response<wbr/>Map</span></a></li>
<li><a href="../types/RequestResponseMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Request<wbr/>Response<wbr/>Map</span></a></li>
<li><a href="../types/Response.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Response</span></a></li>
<li><a href="../types/ServerState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Server<wbr/>State</span></a></li>
<li><a href="../types/SetFee.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Set<wbr/>Fee</span></a></li>
<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>
<li><a href="../functions/classicAddressToXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><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"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>classic<wbr/>Address<wbr/>ToXAddress</span></a></li>
<li><a href="../functions/convertHexToString.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>Hex<wbr/>To<wbr/>String</span></a></li>
<li><a href="../functions/convertStringToHex.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>String<wbr/>To<wbr/>Hex</span></a></li>
<li><a href="../functions/decimalToQuality.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decimal<wbr/>To<wbr/>Quality</span></a></li>
<li><a href="../functions/decimalToTransferRate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decimal<wbr/>To<wbr/>Transfer<wbr/>Rate</span></a></li>
<li><a href="../functions/decode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decode</span></a></li>
<li><a href="../functions/decodeAccountID.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decode<wbr/>AccountID</span></a></li>
<li><a href="../functions/decodeAccountPublic.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decode<wbr/>Account<wbr/>Public</span></a></li>
<li><a href="../functions/decodeNodePublic.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></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" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decode<wbr/>Seed</span></a></li>
<li><a href="../functions/decodeXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>decodeXAddress</span></a></li>
<li><a href="../functions/deriveAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>derive<wbr/>Address</span></a></li>
<li><a href="../functions/deriveKeypair.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>derive<wbr/>Keypair</span></a></li>
<li><a href="../functions/deriveXAddress.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>deriveXAddress</span></a></li>
<li><a href="../functions/dropsToXrp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>drops<wbr/>To<wbr/>Xrp</span></a></li>
<li><a href="../functions/encode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode</span></a></li>
<li><a href="../functions/encodeAccountID.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>AccountID</span></a></li>
<li><a href="../functions/encodeAccountPublic.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>Account<wbr/>Public</span></a></li>
<li><a href="../functions/encodeForMultiSigning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>For<wbr/>Multi<wbr/>Signing</span></a></li>
<li><a href="../functions/encodeForSigning.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>For<wbr/>Signing</span></a></li>
<li><a href="../functions/encodeForSigningClaim.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>For<wbr/>Signing<wbr/>Claim</span></a></li>
<li><a href="../functions/encodeNodePublic.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>Node<wbr/>Public</span></a></li>
<li><a href="../functions/encodeSeed.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encode<wbr/>Seed</span></a></li>
<li><a href="../functions/encodeXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>encodeXAddress</span></a></li>
<li><a href="../functions/getBalanceChanges.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>get<wbr/>Balance<wbr/>Changes</span></a></li>
<li><a href="../functions/getNFTokenID.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>getNFTokenID</span></a></li>
<li><a href="../functions/getXChainClaimID.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>getXChain<wbr/>ClaimID</span></a></li>
<li><a href="../functions/hasNextPage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>has<wbr/>Next<wbr/>Page</span></a></li>
<li><a href="../functions/isCreatedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Created<wbr/>Node</span></a></li>
<li><a href="../functions/isDeletedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Deleted<wbr/>Node</span></a></li>
<li><a href="../functions/isModifiedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Modified<wbr/>Node</span></a></li>
<li><a href="../functions/isValidAddress.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Valid<wbr/>Address</span></a></li>
<li><a href="../functions/isValidClassicAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Valid<wbr/>Classic<wbr/>Address</span></a></li>
<li><a href="../functions/isValidSecret.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>Valid<wbr/>Secret</span></a></li>
<li><a href="../functions/isValidXAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>is<wbr/>ValidXAddress</span></a></li>
<li><a href="../functions/isoTimeToRippleTime.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>iso<wbr/>Time<wbr/>To<wbr/>Ripple<wbr/>Time</span></a></li>
<li><a href="../functions/keyToRFC1751Mnemonic.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>key<wbr/>ToRFC1751<wbr/>Mnemonic</span></a></li>
<li><a href="../functions/multisign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>multisign</span></a></li>
<li><a href="../functions/parseAccountRootFlags.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>parse<wbr/>Account<wbr/>Root<wbr/>Flags</span></a></li>
<li><a href="../functions/parseNFTokenID.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>parseNFTokenID</span></a></li>
<li><a href="../functions/percentToQuality.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>percent<wbr/>To<wbr/>Quality</span></a></li>
<li><a href="../functions/percentToTransferRate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>percent<wbr/>To<wbr/>Transfer<wbr/>Rate</span></a></li>
<li><a href="../functions/qualityToDecimal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>quality<wbr/>To<wbr/>Decimal</span></a></li>
<li><a href="../functions/rfc1751MnemonicToKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>rfc1751<wbr/>Mnemonic<wbr/>To<wbr/>Key</span></a></li>
<li><a href="../functions/rippleTimeToISOTime.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>ripple<wbr/>Time<wbr/>ToISOTime</span></a></li>
<li><a href="../functions/rippleTimeToUnixTime.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>ripple<wbr/>Time<wbr/>To<wbr/>Unix<wbr/>Time</span></a></li>
<li><a href="../functions/setTransactionFlagsToNumber.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>set<wbr/>Transaction<wbr/>Flags<wbr/>To<wbr/>Number</span></a></li>
<li><a href="../functions/signPaymentChannelClaim.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>sign<wbr/>Payment<wbr/>Channel<wbr/>Claim</span></a></li>
<li><a href="../functions/transferRateToDecimal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>transfer<wbr/>Rate<wbr/>To<wbr/>Decimal</span></a></li>
<li><a href="../functions/unixTimeToRippleTime.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></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" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>validate</span></a></li>
<li><a href="../functions/verifyKeypairSignature.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>verify<wbr/>Keypair<wbr/>Signature</span></a></li>
<li><a href="../functions/verifyPaymentChannelClaim.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>verify<wbr/>Payment<wbr/>Channel<wbr/>Claim</span></a></li>
<li><a href="../functions/verifySignature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>verify<wbr/>Signature</span></a></li>
<li><a href="../functions/walletFromSecretNumbers.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>wallet<wbr/>From<wbr/>Secret<wbr/>Numbers</span></a></li>
<li><a href="../functions/xAddressToClassicAddress.html" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>x<wbr/>Address<wbr/>To<wbr/>Classic<wbr/>Address</span></a></li>
<li><a href="../functions/xrpToDrops.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>xrp<wbr/>To<wbr/>Drops</span></a></li></ul></nav></div></div></div>
<div class="tsd-generator">
<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink