ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-20 20:25:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e634db3dd2004b83edeb9884cb5c91dc91b329af
xahau.js/docs/index.html
jonathanlei 93c8562e55 release 2.6.0 (#2145)
2022-11-21 14:18:39 -08:00

382 lines
82 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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 async src="assets/search.js" id="search-script"></script></head><body><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 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>
<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 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-8 col-content">
<div class="tsd-page-title">
<h2>xrpl</h2></div>
<div class="tsd-panel tsd-typography">
<a href="#xrpljs" id="xrpljs" style="color: inherit; text-decoration: none;">
<h1>xrpl.js</h1>
</a>
<p>A JavaScript/TypeScript library for interacting with the XRP Ledger</p>
<p><a href="https://www.npmjs.org/package/xrpl"><img src="https://nodei.co/npm/xrpl.png" alt="NPM"></a>
<img src="https://img.shields.io/bundlephobia/min/xrpl" alt="npm bundle size"></p>
<p>This is the recommended library for integrating a JavaScript/TypeScript app with the XRP Ledger, especially if you intend to use advanced functionality such as IOUs, payment paths, the decentralized exchange, account settings, payment channels, escrows, multi-signing, and more.</p>
<a href="#➡️-reference-documentation" id="➡️-reference-documentation" style="color: inherit; text-decoration: none;">
<h2><a href="http://js.xrpl.org">➡️ Reference Documentation</a></h2>
</a>
<p>See the full reference documentation for all classes, methods, and utilities.</p>
<a href="#➡️-applications-and-projects" id="➡️-applications-and-projects" style="color: inherit; text-decoration: none;">
<h2><a href="https://github.com/XRPLF/xrpl.js/blob/main/APPLICATIONS.md">➡️ Applications and Projects</a></h2>
</a>
<p>What is <code>xrpl.js</code> used for? The applications on the list linked above use <code>xrpl.js</code>. Open a PR to add your app or project to the list!</p>
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
<h3>Features</h3>
</a>
<ul>
<li>Works in Node.js and in web browsers</li>
<li>Helpers for creating requests and parsing responses for the <a href="https://xrpl.org/rippled-api.html">XRP Ledger APIs</a></li>
<li>Listen to events on the XRP Ledger (transactions, ledger, validations, etc.)</li>
<li>Sign and submit transactions to the XRP Ledger</li>
<li>Type definitions for TypeScript</li>
</ul>
<a href="#requirements" id="requirements" style="color: inherit; text-decoration: none;">
<h3>Requirements</h3>
</a>
<ul>
<li><strong><a href="https://nodejs.org/">Node.js v14</a></strong> is recommended. We also support v12 and v16. Other versions may work but are not frequently tested.</li>
</ul>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h2>Getting Started</h2>
</a>
<p>In an existing project (with <code>package.json</code>), install <code>xrpl.js</code>:</p>
<pre><code><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> --</span><span class="hl-0">save</span><span class="hl-1"> </span><span class="hl-0">xrpl</span>
</code></pre>
<p>Or with <code>yarn</code>:</p>
<pre><code><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-0">add</span><span class="hl-1"> </span><span class="hl-0">xrpl</span>
</code></pre>
<p>Example usage:</p>
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">xrpl</span><span class="hl-1"> = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&quot;xrpl&quot;</span><span class="hl-1">)</span><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">main</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">client</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-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">connect</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">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-5">&quot;command&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-5">&quot;account_info&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;account&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-5">&quot;rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;ledger_index&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-5">&quot;validated&quot;</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-0">response</span><span class="hl-1">)</span><br/><br/><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-1">}</span><br/><span class="hl-4">main</span><span class="hl-1">()</span>
</code></pre>
<p>For more examples, see the <a href="#documentation">documentation</a>.</p>
<a href="#using-xrpljs-with-create-react-app" id="using-xrpljs-with-create-react-app" style="color: inherit; text-decoration: none;">
<h3>Using xrpl.js with <code>create-react-app</code></h3>
</a>
<p>To use <code>xrpl.js</code> with React, you need to install shims for core NodeJS modules. Starting with version 5, Webpack stopped including shims by default, so you must modify your Webpack configuration to add the shims you need. Either you can eject your config and modify it, or you can use a library such as <code>react-app-rewired</code>. The example below uses <code>react-app-rewired</code>.</p>
<ol>
<li><p>Install shims (you can use <code>yarn</code> as well):</p>
<pre><code class="language-shell"><span class="hl-1">npm install --save-dev \</span><br/><span class="hl-1"> assert \</span><br/><span class="hl-1"> buffer \</span><br/><span class="hl-1"> crypto-browserify \</span><br/><span class="hl-1"> https-browserify \</span><br/><span class="hl-1"> os-browserify \</span><br/><span class="hl-1"> process \</span><br/><span class="hl-1"> stream-browserify \</span><br/><span class="hl-1"> stream-http \</span><br/><span class="hl-1"> url</span>
</code></pre>
</li>
<li><p>Modify your webpack configuration</p>
<ol>
<li><p>Install <code>react-app-rewired</code></p>
<pre><code class="language-shell"><span class="hl-1">npm install --save-dev react-app-rewired</span>
</code></pre>
</li>
<li><p>At the project root, add a file named <code>config-overrides.js</code> with the following content:</p>
<pre><code class="language-javascript"><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">webpack</span><span class="hl-1"> = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;webpack&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-7">module</span><span class="hl-1">.</span><span class="hl-7">exports</span><span class="hl-1"> = </span><span class="hl-2">function</span><span class="hl-1"> </span><span class="hl-4">override</span><span class="hl-1">(</span><span class="hl-0">config</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">fallback</span><span class="hl-1"> = </span><span class="hl-0">config</span><span class="hl-1">.</span><span class="hl-0">resolve</span><span class="hl-1">.</span><span class="hl-0">fallback</span><span class="hl-1"> || {};</span><br/><span class="hl-1"> </span><span class="hl-7">Object</span><span class="hl-1">.</span><span class="hl-4">assign</span><span class="hl-1">(</span><span class="hl-0">fallback</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;assert&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&quot;assert&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;crypto&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&quot;crypto-browserify&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;http&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&quot;stream-http&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;https&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&quot;https-browserify&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;os&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&quot;os-browserify&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;stream&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&quot;stream-browserify&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;url&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&quot;url&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-5">&quot;ws&quot;</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-0">require</span><span class="hl-1">.</span><span class="hl-4">resolve</span><span class="hl-1">(</span><span class="hl-5">&#39;xrpl/dist/npm/client/WSWrapper&#39;</span><span class="hl-1">),</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-0">config</span><span class="hl-1">.</span><span class="hl-0">resolve</span><span class="hl-1">.</span><span class="hl-0">fallback</span><span class="hl-1"> = </span><span class="hl-0">fallback</span><br/><span class="hl-1"> </span><span class="hl-0">config</span><span class="hl-1">.</span><span class="hl-0">plugins</span><span class="hl-1"> = (</span><span class="hl-0">config</span><span class="hl-1">.</span><span class="hl-0">plugins</span><span class="hl-1"> || []).</span><span class="hl-4">concat</span><span class="hl-1">([</span><br/><span class="hl-1"> </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-0">webpack</span><span class="hl-1">.</span><span class="hl-4">ProvidePlugin</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">process:</span><span class="hl-1"> </span><span class="hl-5">&#39;process/browser&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Buffer:</span><span class="hl-1"> [</span><span class="hl-5">&#39;buffer&#39;</span><span class="hl-1">, </span><span class="hl-5">&#39;Buffer&#39;</span><span class="hl-1">]</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> ])</span><br/><br/><span class="hl-1"> </span><span class="hl-8">// This is deprecated in webpack 5 but alias false does not seem to work</span><br/><span class="hl-1"> </span><span class="hl-0">config</span><span class="hl-1">.</span><span class="hl-0">module</span><span class="hl-1">.</span><span class="hl-0">rules</span><span class="hl-1">.</span><span class="hl-4">push</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">test:</span><span class="hl-9"> /node_modules</span><span class="hl-10">[</span><span class="hl-11">\\\/</span><span class="hl-10">]</span><span class="hl-9">https-proxy-agent</span><span class="hl-10">[</span><span class="hl-11">\\\/</span><span class="hl-10">]</span><span class="hl-9">/</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">use:</span><span class="hl-1"> </span><span class="hl-5">&#39;null-loader&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> </span><span class="hl-6">return</span><span class="hl-1"> </span><span class="hl-0">config</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
</code></pre>
</li>
<li><p>Update package.json scripts section with</p>
<pre><code><span class="hl-5">&quot;start&quot;</span><span class="hl-1">: </span><span class="hl-5">&quot;react-app-rewired start&quot;</span><span class="hl-1">, </span><br/><span class="hl-5">&quot;build&quot;</span><span class="hl-1">: </span><span class="hl-5">&quot;react-app-rewired build&quot;</span><span class="hl-1">,</span><br/><span class="hl-5">&quot;test&quot;</span><span class="hl-1">: </span><span class="hl-5">&quot;react-app-rewired test&quot;</span><span class="hl-1">,</span>
</code></pre>
</li>
</ol>
</li>
</ol>
<a href="#using-xrpljs-with-react-native" id="using-xrpljs-with-react-native" style="color: inherit; text-decoration: none;">
<h3>Using xrpl.js with React Native</h3>
</a>
<p>If you want to use <code>xrpl.js</code> with React Native you will need to install shims for core NodeJS modules. To help with this you can use a module like <a href="https://github.com/tradle/rn-nodeify">rn-nodeify</a>.</p>
<ol>
<li><p>Install dependencies (you can use <code>yarn</code> as well):</p>
<pre><code class="language-shell"><span class="hl-1">npm install react-native-crypto</span><br/><span class="hl-1">npm install xrpl</span><br/><span class="hl-8"># install peer deps</span><br/><span class="hl-1">npm install react-native-randombytes</span><br/><span class="hl-8"># install latest rn-nodeify</span><br/><span class="hl-1">npm install rn-nodeify@latest --dev</span>
</code></pre>
</li>
<li><p>After that, run the following command:</p>
<pre><code class="language-shell"><span class="hl-8"># install node core shims and recursively hack package.json files</span><br/><span class="hl-8"># in ./node_modules to add/update the &quot;browser&quot;/&quot;react-native&quot; field with relevant mappings</span><br/><span class="hl-1">./node_modules/.bin/rn-nodeify --hack --install</span>
</code></pre>
</li>
<li><p>Enable <code>crypto</code>:</p>
<p> <code>rn-nodeify</code> will create a <code>shim.js</code> file in the project root directory.
Open it and uncomment the line that requires the crypto module:</p>
<pre><code class="language-javascript"><span class="hl-8">// If using the crypto shim, uncomment the following line to ensure</span><br/><span class="hl-8">// crypto is loaded first, so it can populate global.crypto</span><br/><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">&#39;crypto&#39;</span><span class="hl-1">)</span>
</code></pre>
</li>
<li><p>Import <code>shim</code> in your project (it must be the first line):</p>
</li>
</ol>
<pre><code class="language-javascript"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-5">&#39;./shim&#39;</span><br/><span class="hl-1">...</span>
</code></pre>
<a href="#using-xrpljs-with-deno" id="using-xrpljs-with-deno" style="color: inherit; text-decoration: none;">
<h3>Using xrpl.js with Deno</h3>
</a>
<p>Until official support for <a href="https://deno.land">Deno</a> is added, you can use the following work-around to use <code>xrpl.js</code> with Deno:</p>
<pre><code class="language-javascript"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-0">xrpl</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-5">&#39;https://dev.jspm.io/npm:xrpl&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-2">async</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-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-6">as</span><span class="hl-1"> </span><span class="hl-7">any</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-1"> </span><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;rH8NxV12EuV...khfJ5uw9kT&#39;</span><span class="hl-1">;</span><br/><br/><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><span class="hl-4">then</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">api</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-4">then</span><span class="hl-1">((</span><span class="hl-0">balances</span><span class="hl-1">: </span><span class="hl-7">any</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-7">JSON</span><span class="hl-1">.</span><span class="hl-4">stringify</span><span class="hl-1">(</span><span class="hl-0">balances</span><span class="hl-1">, </span><span class="hl-2">null</span><span class="hl-1">, </span><span class="hl-12">2</span><span class="hl-1">));</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> });</span><br/><span class="hl-1">})();</span>
</code></pre>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h2>Documentation</h2>
</a>
<ul>
<li><a href="https://xrpl.org/get-started-using-node-js.html">Get Started in Node.js</a></li>
<li><a href="https://js.xrpl.org">Full Reference Documentation</a></li>
<li><a href="https://github.com/XRPLF/xrpl.js/tree/main/packages/xrpl/snippets/src">Code Samples</a></li>
</ul>
<a href="#mailing-lists" id="mailing-lists" style="color: inherit; text-decoration: none;">
<h3>Mailing Lists</h3>
</a>
<p>We have a low-traffic mailing list for announcements of new <code>xrpl.js</code> releases. (About 1 email per week)</p>
<ul>
<li><a href="https://groups.google.com/g/xrpl-announce">Subscribe to xrpl-announce</a></li>
</ul>
<p>If you&#39;re using the XRP Ledger in production, you should run a <a href="https://github.com/ripple/rippled">rippled server</a> and subscribe to the ripple-server mailing list as well.</p>
<ul>
<li><a href="https://groups.google.com/g/ripple-server">Subscribe to ripple-server</a></li>
</ul>
<a href="#report-an-issue" id="report-an-issue" style="color: inherit; text-decoration: none;">
<h3>Report an issue</h3>
</a>
<p>Experienced an issue? Report it <a href="https://github.com/XRPLF/xrpl.js/issues/new">here</a>.</p>
<a href="#more-information" id="more-information" style="color: inherit; text-decoration: none;">
<h2>More Information</h2>
</a>
<ul>
<li><a href="https://groups.google.com/g/xrpl-announce">xrpl-announce mailing list</a> - subscribe for release announcements</li>
<li><a href="https://js.xrpl.org">xrpl.js API Reference</a></li>
<li><a href="https://xrpl.org">XRP Ledger Dev Portal</a></li>
</ul>
</div></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<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)"></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="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<nav class="tsd-navigation primary">
<details class="tsd-index-accordion" open><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)"></path></svg> Modules</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li class="current selected"><a href="modules.html">xrpl</a>
<ul>
<li class="tsd-kind-namespace"><a href="modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></li></ul></div></details></nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
<li class="tsd-kind-enum"><a href="enums/AccountSetAsfFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-8-path"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)" id="icon-8-text"></path></svg>Account<wbr/>Set<wbr/>Asf<wbr/>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/AccountSetTfFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Account<wbr/>Set<wbr/>Tf<wbr/>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/NFTokenCreateOfferFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>NFToken<wbr/>Create<wbr/>Offer<wbr/>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/NFTokenMintFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>NFToken<wbr/>Mint<wbr/>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/OfferCreateFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Offer<wbr/>Create<wbr/>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/PaymentChannelClaimFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/PaymentFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Payment<wbr/>Flags</a></li>
<li class="tsd-kind-enum"><a href="enums/TrustSetFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8-path"></use><use href="#icon-8-text"></use></svg>Trust<wbr/>Set<wbr/>Flags</a></li>
<li class="deprecated tsd-kind-class"><a href="classes/BroadcastClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-128-path"></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)" id="icon-128-text"></path></svg>Broadcast<wbr/>Client</a></li>
<li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Client</a></li>
<li class="tsd-kind-class"><a href="classes/ConnectionError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Connection<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/DisconnectedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Disconnected<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/NotConnectedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Not<wbr/>Connected<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/NotFoundError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Not<wbr/>Found<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/ResponseFormatError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Response<wbr/>Format<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/RippledError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Rippled<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/RippledNotInitializedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Rippled<wbr/>Not<wbr/>Initialized<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/TimeoutError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Timeout<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/UnexpectedError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Unexpected<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/ValidationError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Validation<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/Wallet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Wallet</a></li>
<li class="tsd-kind-class"><a href="classes/XRPLFaucetError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>XRPLFaucet<wbr/>Error</a></li>
<li class="tsd-kind-class"><a href="classes/XrplError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Xrpl<wbr/>Error</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountChannelsRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Account<wbr/>Channels<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountChannelsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Channels<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountCurrenciesRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Currencies<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountCurrenciesResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Currencies<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountDelete.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Delete</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountInfoRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Info<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountInfoResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Info<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountLinesRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Lines<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountLinesResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Lines<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountNFTsRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>AccountNFTs<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountNFTsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>AccountNFTs<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountObjectsRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Objects<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountObjectsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Objects<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountOffer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Offer</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountOffersRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Offers<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountOffersResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Offers<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountSet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Set</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountSetFlagsInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Set<wbr/>Flags<wbr/>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountTxRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Tx<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/AccountTxResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Account<wbr/>Tx<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/BookOffer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Book<wbr/>Offer</a></li>
<li class="tsd-kind-interface"><a href="interfaces/BookOffersRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Book<wbr/>Offers<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/BookOffersResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Book<wbr/>Offers<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ChannelVerifyRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Channel<wbr/>Verify<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ChannelVerifyResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Channel<wbr/>Verify<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/CheckCancel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Check<wbr/>Cancel</a></li>
<li class="tsd-kind-interface"><a href="interfaces/CheckCash.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Check<wbr/>Cash</a></li>
<li class="tsd-kind-interface"><a href="interfaces/CheckCreate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Check<wbr/>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ClientOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Client<wbr/>Options</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ConsensusStream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Consensus<wbr/>Stream</a></li>
<li class="tsd-kind-interface"><a href="interfaces/DepositAuthorizedRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Deposit<wbr/>Authorized<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/DepositAuthorizedResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Deposit<wbr/>Authorized<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/DepositPreauth.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Deposit<wbr/>Preauth</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ErrorResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Error<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/EscrowCancel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Escrow<wbr/>Cancel</a></li>
<li class="tsd-kind-interface"><a href="interfaces/EscrowCreate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Escrow<wbr/>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/EscrowFinish.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Escrow<wbr/>Finish</a></li>
<li class="tsd-kind-interface"><a href="interfaces/FederatorInfoRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Federator<wbr/>Info<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/FederatorInfoResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Federator<wbr/>Info<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/FeeRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Fee<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/FeeResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Fee<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/GatewayBalancesRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Gateway<wbr/>Balances<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/GatewayBalancesResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Gateway<wbr/>Balances<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerClosedRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Closed<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerClosedResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Closed<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerCurrentRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Current<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerCurrentResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Current<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerDataRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Data<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerDataResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Data<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerEntryRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Entry<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerEntryResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Entry<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/LedgerStream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ledger<wbr/>Stream</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ManifestRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Manifest<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ManifestResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Manifest<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTBuyOffersRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFTBuy<wbr/>Offers<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTBuyOffersResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFTBuy<wbr/>Offers<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTSellOffersRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFTSell<wbr/>Offers<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTSellOffersResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFTSell<wbr/>Offers<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTokenAcceptOffer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFToken<wbr/>Accept<wbr/>Offer</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTokenBurn.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFToken<wbr/>Burn</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTokenCancelOffer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFToken<wbr/>Cancel<wbr/>Offer</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTokenCreateOffer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFToken<wbr/>Create<wbr/>Offer</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTokenCreateOfferFlagsInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFToken<wbr/>Create<wbr/>Offer<wbr/>Flags<wbr/>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTokenMint.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFToken<wbr/>Mint</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NFTokenMintFlagsInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>NFToken<wbr/>Mint<wbr/>Flags<wbr/>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NoRippleCheckRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>No<wbr/>Ripple<wbr/>Check<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/NoRippleCheckResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>No<wbr/>Ripple<wbr/>Check<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/OfferCancel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Offer<wbr/>Cancel</a></li>
<li class="tsd-kind-interface"><a href="interfaces/OfferCreate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Offer<wbr/>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/OfferCreateFlagsInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Offer<wbr/>Create<wbr/>Flags<wbr/>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/OrderBookStream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Order<wbr/>Book<wbr/>Stream</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PathFindCloseRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Path<wbr/>Find<wbr/>Close<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PathFindCreateRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Path<wbr/>Find<wbr/>Create<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PathFindResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Path<wbr/>Find<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PathFindStatusRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Path<wbr/>Find<wbr/>Status<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PathFindStream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Path<wbr/>Find<wbr/>Stream</a></li>
<li class="tsd-kind-interface"><a href="interfaces/Payment.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Payment</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelClaim.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Payment<wbr/>Channel<wbr/>Claim</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelClaimFlagsInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags<wbr/>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelCreate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Payment<wbr/>Channel<wbr/>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentChannelFund.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Payment<wbr/>Channel<wbr/>Fund</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PaymentFlagsInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Payment<wbr/>Flags<wbr/>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PeerStatusStream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Peer<wbr/>Status<wbr/>Stream</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PingRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ping<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/PingResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ping<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/RandomRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Random<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/RandomResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Random<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/RipplePathFindRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ripple<wbr/>Path<wbr/>Find<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/RipplePathFindResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ripple<wbr/>Path<wbr/>Find<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ServerInfoRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Server<wbr/>Info<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ServerInfoResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Server<wbr/>Info<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ServerStateRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Server<wbr/>State<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ServerStateResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Server<wbr/>State<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SetRegularKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Set<wbr/>Regular<wbr/>Key</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SignerListSet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Signer<wbr/>List<wbr/>Set</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SubmitMultisignedRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Submit<wbr/>Multisigned<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SubmitMultisignedResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Submit<wbr/>Multisigned<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SubmitRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Submit<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SubmitResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Submit<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SubscribeRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Subscribe<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/SubscribeResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Subscribe<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TicketCreate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ticket<wbr/>Create</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TransactionAndMetadata.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Transaction<wbr/>And<wbr/>Metadata</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TransactionEntryRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Transaction<wbr/>Entry<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TransactionEntryResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Transaction<wbr/>Entry<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TransactionMetadata.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Transaction<wbr/>Metadata</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TransactionStream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Transaction<wbr/>Stream</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TrustSet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Trust<wbr/>Set</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TrustSetFlagsInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Trust<wbr/>Set<wbr/>Flags<wbr/>Interface</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TxRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Tx<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/TxResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Tx<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/UnsubscribeRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Unsubscribe<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="interfaces/UnsubscribeResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Unsubscribe<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ValidationStream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Validation<wbr/>Stream</a></li>
<li class="tsd-kind-type-alias"><a href="types/PathFindRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Path<wbr/>Find<wbr/>Request</a></li>
<li class="tsd-kind-type-alias"><a href="types/Request.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Request</a></li>
<li class="tsd-kind-type-alias"><a href="types/Response.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Response</a></li>
<li class="tsd-kind-type-alias"><a href="types/Stream.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Stream</a></li>
<li class="tsd-kind-type-alias"><a href="types/Transaction.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Transaction</a></li>
<li class="tsd-kind-property tsd-is-external"><a href="modules.html#deriveAddress" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></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)" id="icon-1024-text"></path></svg>derive<wbr/>Address</a></li>
<li class="tsd-kind-property tsd-is-external"><a href="modules.html#deriveKeypair" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>derive<wbr/>Keypair</a></li>
<li class="tsd-kind-property tsd-is-external"><a href="modules.html#verifyKeypairSignature" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>verify<wbr/>Keypair<wbr/>Signature</a></li>
<li class="tsd-kind-variable"><a href="variables/hashes.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-32-path"></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)" id="icon-32-text"></path></svg>hashes</a></li>
<li class="tsd-kind-function"><a href="functions/authorizeChannel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>authorize<wbr/>Channel</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/classicAddressToXAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>classic<wbr/>Address<wbr/>ToXAddress</a></li>
<li class="tsd-kind-function"><a href="functions/convertHexToString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>convert<wbr/>Hex<wbr/>To<wbr/>String</a></li>
<li class="tsd-kind-function"><a href="functions/convertStringToHex.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>convert<wbr/>String<wbr/>To<wbr/>Hex</a></li>
<li class="tsd-kind-function"><a href="functions/createCrossChainPayment.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>Cross<wbr/>Chain<wbr/>Payment</a></li>
<li class="tsd-kind-function"><a href="functions/decimalToQuality.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decimal<wbr/>To<wbr/>Quality</a></li>
<li class="tsd-kind-function"><a href="functions/decimalToTransferRate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decimal<wbr/>To<wbr/>Transfer<wbr/>Rate</a></li>
<li class="tsd-kind-function"><a href="functions/decode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decode</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/decodeAccountID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decode<wbr/>AccountID</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/decodeAccountPublic.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decode<wbr/>Account<wbr/>Public</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/decodeNodePublic.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decode<wbr/>Node<wbr/>Public</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/decodeSeed.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decode<wbr/>Seed</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/decodeXAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decodeXAddress</a></li>
<li class="tsd-kind-function"><a href="functions/deriveXAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>deriveXAddress</a></li>
<li class="tsd-kind-function"><a href="functions/dropsToXrp.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>drops<wbr/>To<wbr/>Xrp</a></li>
<li class="tsd-kind-function"><a href="functions/encode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/encodeAccountID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode<wbr/>AccountID</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/encodeAccountPublic.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode<wbr/>Account<wbr/>Public</a></li>
<li class="tsd-kind-function"><a href="functions/encodeForMultiSigning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode<wbr/>For<wbr/>Multi<wbr/>Signing</a></li>
<li class="tsd-kind-function"><a href="functions/encodeForSigning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode<wbr/>For<wbr/>Signing</a></li>
<li class="tsd-kind-function"><a href="functions/encodeForSigningClaim.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode<wbr/>For<wbr/>Signing<wbr/>Claim</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/encodeNodePublic.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode<wbr/>Node<wbr/>Public</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/encodeSeed.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encode<wbr/>Seed</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/encodeXAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>encodeXAddress</a></li>
<li class="tsd-kind-function"><a href="functions/getBalanceChanges.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get<wbr/>Balance<wbr/>Changes</a></li>
<li class="tsd-kind-function"><a href="functions/hasNextPage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>has<wbr/>Next<wbr/>Page</a></li>
<li class="tsd-kind-function"><a href="functions/isValidAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>Valid<wbr/>Address</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/isValidClassicAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>Valid<wbr/>Classic<wbr/>Address</a></li>
<li class="tsd-kind-function"><a href="functions/isValidSecret.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>Valid<wbr/>Secret</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/isValidXAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>ValidXAddress</a></li>
<li class="tsd-kind-function"><a href="functions/isoTimeToRippleTime.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>iso<wbr/>Time<wbr/>To<wbr/>Ripple<wbr/>Time</a></li>
<li class="tsd-kind-function"><a href="functions/keyToRFC1751Mnemonic.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>key<wbr/>ToRFC1751<wbr/>Mnemonic</a></li>
<li class="tsd-kind-function"><a href="functions/multisign.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>multisign</a></li>
<li class="tsd-kind-function"><a href="functions/parseAccountRootFlags.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>parse<wbr/>Account<wbr/>Root<wbr/>Flags</a></li>
<li class="tsd-kind-function"><a href="functions/parseNFTokenID.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>parseNFTokenID</a></li>
<li class="tsd-kind-function"><a href="functions/percentToQuality.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>percent<wbr/>To<wbr/>Quality</a></li>
<li class="tsd-kind-function"><a href="functions/percentToTransferRate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>percent<wbr/>To<wbr/>Transfer<wbr/>Rate</a></li>
<li class="tsd-kind-function"><a href="functions/qualityToDecimal.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>quality<wbr/>To<wbr/>Decimal</a></li>
<li class="tsd-kind-function"><a href="functions/rfc1751MnemonicToKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>rfc1751<wbr/>Mnemonic<wbr/>To<wbr/>Key</a></li>
<li class="tsd-kind-function"><a href="functions/rippleTimeToISOTime.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ripple<wbr/>Time<wbr/>ToISOTime</a></li>
<li class="tsd-kind-function"><a href="functions/rippleTimeToUnixTime.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>ripple<wbr/>Time<wbr/>To<wbr/>Unix<wbr/>Time</a></li>
<li class="tsd-kind-function"><a href="functions/setTransactionFlagsToNumber.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>set<wbr/>Transaction<wbr/>Flags<wbr/>To<wbr/>Number</a></li>
<li class="tsd-kind-function"><a href="functions/signPaymentChannelClaim.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>sign<wbr/>Payment<wbr/>Channel<wbr/>Claim</a></li>
<li class="tsd-kind-function"><a href="functions/transferRateToDecimal.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>transfer<wbr/>Rate<wbr/>To<wbr/>Decimal</a></li>
<li class="tsd-kind-function"><a href="functions/unixTimeToRippleTime.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>unix<wbr/>Time<wbr/>To<wbr/>Ripple<wbr/>Time</a></li>
<li class="tsd-kind-function"><a href="functions/validate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>validate</a></li>
<li class="tsd-kind-function"><a href="functions/verifyPaymentChannelClaim.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>verify<wbr/>Payment<wbr/>Channel<wbr/>Claim</a></li>
<li class="tsd-kind-function"><a href="functions/verifySignature.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>verify<wbr/>Signature</a></li>
<li class="tsd-kind-function tsd-is-external"><a href="functions/xAddressToClassicAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>x<wbr/>Address<wbr/>To<wbr/>Classic<wbr/>Address</a></li>
<li class="tsd-kind-function"><a href="functions/xrpToDrops.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>xrp<wbr/>To<wbr/>Drops</a></li></ul></nav></div></div>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div><script src="assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink