mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-04-29 15:37:50 +00:00
e813ec4bd3
Make all exported function parameters and return types show their shapes so that new developers can see how to use them in the docs.
111 lines
38 KiB
HTML
111 lines
38 KiB
HTML
<!DOCTYPE html><html class="default no-js"><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><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>xrpl</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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/master/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>
|
|
<li><strong><a href="https://www.npmjs.com/">npm</a></strong> is recommended. <code>yarn</code> may work but we use <code>package-lock.json</code>.</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">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">"xrpl"</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">"https://s.altnet.rippletest.net:51234/"</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">"command"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-5">"account_info"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">"account"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-5">"rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">"ledger_index"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-5">"validated"</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-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-7"># install peer deps</span><br/><span class="hl-1">npm install react-native-randombytes</span><br/><span class="hl-7"># 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-7"># install node core shims and recursively hack package.json files</span><br/><span class="hl-7"># in ./node_modules to add/update the "browser"/"react-native" 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-7">// If using the crypto shim, uncomment the following line to ensure</span><br/><span class="hl-7">// 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">'crypto'</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">'./shim'</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">'https://dev.jspm.io/npm:xrpl'</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">=></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-8">any</span><span class="hl-1">).</span><span class="hl-4">Client</span><span class="hl-1">(</span><span class="hl-5">'wss://s.altnet.rippletest.net:51233'</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">'rH8NxV12EuV...khfJ5uw9kT'</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">=></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-8">any</span><span class="hl-1">) </span><span class="hl-2">=></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-8">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-9">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/develop/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'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="#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"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/AccountSetAsfFlags.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Asf<wbr/>Flags</a></li><li class="tsd-kind-enum"><a href="enums/AccountSetTfFlags.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Tf<wbr/>Flags</a></li><li class="tsd-kind-enum"><a href="enums/OfferCreateFlags.html" class="tsd-kind-icon">Offer<wbr/>Create<wbr/>Flags</a></li><li class="tsd-kind-enum"><a href="enums/PaymentChannelClaimFlags.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags</a></li><li class="tsd-kind-enum"><a href="enums/PaymentFlags.html" class="tsd-kind-icon">Payment<wbr/>Flags</a></li><li class="tsd-kind-enum"><a href="enums/TrustSetFlags.html" class="tsd-kind-icon">Trust<wbr/>Set<wbr/>Flags</a></li><li class="tsd-kind-class"><a href="classes/BroadcastClient.html" class="tsd-kind-icon">Broadcast<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-kind-icon">Client</a></li><li class="tsd-kind-class"><a href="classes/ConnectionError.html" class="tsd-kind-icon">Connection<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/DisconnectedError.html" class="tsd-kind-icon">Disconnected<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/NotConnectedError.html" class="tsd-kind-icon">Not<wbr/>Connected<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/NotFoundError.html" class="tsd-kind-icon">Not<wbr/>Found<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/ResponseFormatError.html" class="tsd-kind-icon">Response<wbr/>Format<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/RippledError.html" class="tsd-kind-icon">Rippled<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/RippledNotInitializedError.html" class="tsd-kind-icon">Rippled<wbr/>Not<wbr/>Initialized<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/TimeoutError.html" class="tsd-kind-icon">Timeout<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/UnexpectedError.html" class="tsd-kind-icon">Unexpected<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/ValidationError.html" class="tsd-kind-icon">Validation<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/Wallet.html" class="tsd-kind-icon">Wallet</a></li><li class="tsd-kind-class"><a href="classes/XRPLFaucetError.html" class="tsd-kind-icon">XRPLFaucet<wbr/>Error</a></li><li class="tsd-kind-class"><a href="classes/XrplError.html" class="tsd-kind-icon">Xrpl<wbr/>Error</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountChannelsRequest.html" class="tsd-kind-icon">Account<wbr/>Channels<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountChannelsResponse.html" class="tsd-kind-icon">Account<wbr/>Channels<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountCurrenciesRequest.html" class="tsd-kind-icon">Account<wbr/>Currencies<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountCurrenciesResponse.html" class="tsd-kind-icon">Account<wbr/>Currencies<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountDelete.html" class="tsd-kind-icon">Account<wbr/>Delete</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountInfoRequest.html" class="tsd-kind-icon">Account<wbr/>Info<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountInfoResponse.html" class="tsd-kind-icon">Account<wbr/>Info<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountLinesRequest.html" class="tsd-kind-icon">Account<wbr/>Lines<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountLinesResponse.html" class="tsd-kind-icon">Account<wbr/>Lines<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountObjectsRequest.html" class="tsd-kind-icon">Account<wbr/>Objects<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountObjectsResponse.html" class="tsd-kind-icon">Account<wbr/>Objects<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountOffersRequest.html" class="tsd-kind-icon">Account<wbr/>Offers<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountOffersResponse.html" class="tsd-kind-icon">Account<wbr/>Offers<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountSet.html" class="tsd-kind-icon">Account<wbr/>Set</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountSetFlagsInterface.html" class="tsd-kind-icon">Account<wbr/>Set<wbr/>Flags<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountTxRequest.html" class="tsd-kind-icon">Account<wbr/>Tx<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/AccountTxResponse.html" class="tsd-kind-icon">Account<wbr/>Tx<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/BookOffer.html" class="tsd-kind-icon">Book<wbr/>Offer</a></li><li class="tsd-kind-interface"><a href="interfaces/BookOffersRequest.html" class="tsd-kind-icon">Book<wbr/>Offers<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/BookOffersResponse.html" class="tsd-kind-icon">Book<wbr/>Offers<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/ChannelVerifyRequest.html" class="tsd-kind-icon">Channel<wbr/>Verify<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/ChannelVerifyResponse.html" class="tsd-kind-icon">Channel<wbr/>Verify<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/CheckCancel.html" class="tsd-kind-icon">Check<wbr/>Cancel</a></li><li class="tsd-kind-interface"><a href="interfaces/CheckCash.html" class="tsd-kind-icon">Check<wbr/>Cash</a></li><li class="tsd-kind-interface"><a href="interfaces/CheckCreate.html" class="tsd-kind-icon">Check<wbr/>Create</a></li><li class="tsd-kind-interface"><a href="interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/ConsensusStream.html" class="tsd-kind-icon">Consensus<wbr/>Stream</a></li><li class="tsd-kind-interface"><a href="interfaces/DepositAuthorizedRequest.html" class="tsd-kind-icon">Deposit<wbr/>Authorized<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/DepositAuthorizedResponse.html" class="tsd-kind-icon">Deposit<wbr/>Authorized<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/DepositPreauth.html" class="tsd-kind-icon">Deposit<wbr/>Preauth</a></li><li class="tsd-kind-interface"><a href="interfaces/ErrorResponse.html" class="tsd-kind-icon">Error<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/EscrowCancel.html" class="tsd-kind-icon">Escrow<wbr/>Cancel</a></li><li class="tsd-kind-interface"><a href="interfaces/EscrowCreate.html" class="tsd-kind-icon">Escrow<wbr/>Create</a></li><li class="tsd-kind-interface"><a href="interfaces/EscrowFinish.html" class="tsd-kind-icon">Escrow<wbr/>Finish</a></li><li class="tsd-kind-interface"><a href="interfaces/FeeRequest.html" class="tsd-kind-icon">Fee<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/FeeResponse.html" class="tsd-kind-icon">Fee<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/GatewayBalancesRequest.html" class="tsd-kind-icon">Gateway<wbr/>Balances<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/GatewayBalancesResponse.html" class="tsd-kind-icon">Gateway<wbr/>Balances<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerClosedRequest.html" class="tsd-kind-icon">Ledger<wbr/>Closed<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerClosedResponse.html" class="tsd-kind-icon">Ledger<wbr/>Closed<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerCurrentRequest.html" class="tsd-kind-icon">Ledger<wbr/>Current<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerCurrentResponse.html" class="tsd-kind-icon">Ledger<wbr/>Current<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerDataRequest.html" class="tsd-kind-icon">Ledger<wbr/>Data<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerDataResponse.html" class="tsd-kind-icon">Ledger<wbr/>Data<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerEntryRequest.html" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerEntryResponse.html" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerRequest.html" class="tsd-kind-icon">Ledger<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerResponse.html" class="tsd-kind-icon">Ledger<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/LedgerStream.html" class="tsd-kind-icon">Ledger<wbr/>Stream</a></li><li class="tsd-kind-interface"><a href="interfaces/ManifestRequest.html" class="tsd-kind-icon">Manifest<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/ManifestResponse.html" class="tsd-kind-icon">Manifest<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/NoRippleCheckRequest.html" class="tsd-kind-icon">No<wbr/>Ripple<wbr/>Check<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/NoRippleCheckResponse.html" class="tsd-kind-icon">No<wbr/>Ripple<wbr/>Check<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/OfferCancel.html" class="tsd-kind-icon">Offer<wbr/>Cancel</a></li><li class="tsd-kind-interface"><a href="interfaces/OfferCreate.html" class="tsd-kind-icon">Offer<wbr/>Create</a></li><li class="tsd-kind-interface"><a href="interfaces/OfferCreateFlagsInterface.html" class="tsd-kind-icon">Offer<wbr/>Create<wbr/>Flags<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/OrderBookStream.html" class="tsd-kind-icon">Order<wbr/>Book<wbr/>Stream</a></li><li class="tsd-kind-interface"><a href="interfaces/PathFindCloseRequest.html" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Close<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/PathFindCreateRequest.html" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Create<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/PathFindResponse.html" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/PathFindStatusRequest.html" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Status<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/PathFindStream.html" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Stream</a></li><li class="tsd-kind-interface"><a href="interfaces/Payment.html" class="tsd-kind-icon">Payment</a></li><li class="tsd-kind-interface"><a href="interfaces/PaymentChannelClaim.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Claim</a></li><li class="tsd-kind-interface"><a href="interfaces/PaymentChannelClaimFlagsInterface.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Claim<wbr/>Flags<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/PaymentChannelCreate.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Create</a></li><li class="tsd-kind-interface"><a href="interfaces/PaymentChannelFund.html" class="tsd-kind-icon">Payment<wbr/>Channel<wbr/>Fund</a></li><li class="tsd-kind-interface"><a href="interfaces/PaymentFlagsInterface.html" class="tsd-kind-icon">Payment<wbr/>Flags<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/PeerStatusStream.html" class="tsd-kind-icon">Peer<wbr/>Status<wbr/>Stream</a></li><li class="tsd-kind-interface"><a href="interfaces/PingRequest.html" class="tsd-kind-icon">Ping<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/PingResponse.html" class="tsd-kind-icon">Ping<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/RandomRequest.html" class="tsd-kind-icon">Random<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/RandomResponse.html" class="tsd-kind-icon">Random<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/RipplePathFindRequest.html" class="tsd-kind-icon">Ripple<wbr/>Path<wbr/>Find<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/RipplePathFindResponse.html" class="tsd-kind-icon">Ripple<wbr/>Path<wbr/>Find<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/ServerInfoRequest.html" class="tsd-kind-icon">Server<wbr/>Info<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/ServerInfoResponse.html" class="tsd-kind-icon">Server<wbr/>Info<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/ServerStateRequest.html" class="tsd-kind-icon">Server<wbr/>State<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/ServerStateResponse.html" class="tsd-kind-icon">Server<wbr/>State<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/SetRegularKey.html" class="tsd-kind-icon">Set<wbr/>Regular<wbr/>Key</a></li><li class="tsd-kind-interface"><a href="interfaces/SignerListSet.html" class="tsd-kind-icon">Signer<wbr/>List<wbr/>Set</a></li><li class="tsd-kind-interface"><a href="interfaces/SubmitMultisignedRequest.html" class="tsd-kind-icon">Submit<wbr/>Multisigned<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/SubmitMultisignedResponse.html" class="tsd-kind-icon">Submit<wbr/>Multisigned<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/SubmitRequest.html" class="tsd-kind-icon">Submit<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/SubmitResponse.html" class="tsd-kind-icon">Submit<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/SubscribeRequest.html" class="tsd-kind-icon">Subscribe<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/SubscribeResponse.html" class="tsd-kind-icon">Subscribe<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/TicketCreate.html" class="tsd-kind-icon">Ticket<wbr/>Create</a></li><li class="tsd-kind-interface"><a href="interfaces/TransactionAndMetadata.html" class="tsd-kind-icon">Transaction<wbr/>And<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/TransactionEntryRequest.html" class="tsd-kind-icon">Transaction<wbr/>Entry<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/TransactionEntryResponse.html" class="tsd-kind-icon">Transaction<wbr/>Entry<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/TransactionMetadata.html" class="tsd-kind-icon">Transaction<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/TransactionStream.html" class="tsd-kind-icon">Transaction<wbr/>Stream</a></li><li class="tsd-kind-interface"><a href="interfaces/TrustSet.html" class="tsd-kind-icon">Trust<wbr/>Set</a></li><li class="tsd-kind-interface"><a href="interfaces/TrustSetFlagsInterface.html" class="tsd-kind-icon">Trust<wbr/>Set<wbr/>Flags<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/TxRequest.html" class="tsd-kind-icon">Tx<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/TxResponse.html" class="tsd-kind-icon">Tx<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/UnsubscribeRequest.html" class="tsd-kind-icon">Unsubscribe<wbr/>Request</a></li><li class="tsd-kind-interface"><a href="interfaces/UnsubscribeResponse.html" class="tsd-kind-icon">Unsubscribe<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/ValidationStream.html" class="tsd-kind-icon">Validation<wbr/>Stream</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PathFindRequest" class="tsd-kind-icon">Path<wbr/>Find<wbr/>Request</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Request" class="tsd-kind-icon">Request</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Response" class="tsd-kind-icon">Response</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Stream" class="tsd-kind-icon">Stream</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Transaction" class="tsd-kind-icon">Transaction</a></li><li class="tsd-kind-property tsd-is-external"><a href="modules.html#deriveKeypair" class="tsd-kind-icon">derive<wbr/>Keypair</a></li><li class="tsd-kind-variable"><a href="modules.html#hashes" class="tsd-kind-icon">hashes</a></li><li class="tsd-kind-function"><a href="modules.html#authorizeChannel" class="tsd-kind-icon">authorize<wbr/>Channel</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#classicAddressToXAddress" class="tsd-kind-icon">classic<wbr/>Address<wbr/>ToXAddress</a></li><li class="tsd-kind-function"><a href="modules.html#convertHexToString" class="tsd-kind-icon">convert<wbr/>Hex<wbr/>To<wbr/>String</a></li><li class="tsd-kind-function"><a href="modules.html#convertStringToHex" class="tsd-kind-icon">convert<wbr/>String<wbr/>To<wbr/>Hex</a></li><li class="tsd-kind-function"><a href="modules.html#decimalToQuality" class="tsd-kind-icon">decimal<wbr/>To<wbr/>Quality</a></li><li class="tsd-kind-function"><a href="modules.html#decimalToTransferRate" class="tsd-kind-icon">decimal<wbr/>To<wbr/>Transfer<wbr/>Rate</a></li><li class="tsd-kind-function"><a href="modules.html#decode" class="tsd-kind-icon">decode</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeAccountID" class="tsd-kind-icon">decode<wbr/>AccountID</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeAccountPublic" class="tsd-kind-icon">decode<wbr/>Account<wbr/>Public</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeNodePublic" class="tsd-kind-icon">decode<wbr/>Node<wbr/>Public</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeSeed" class="tsd-kind-icon">decode<wbr/>Seed</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#decodeXAddress" class="tsd-kind-icon">decodeXAddress</a></li><li class="tsd-kind-function"><a href="modules.html#deriveXAddress" class="tsd-kind-icon">deriveXAddress</a></li><li class="tsd-kind-function"><a href="modules.html#dropsToXrp" class="tsd-kind-icon">drops<wbr/>To<wbr/>Xrp</a></li><li class="tsd-kind-function"><a href="modules.html#encode" class="tsd-kind-icon">encode</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeAccountID" class="tsd-kind-icon">encode<wbr/>AccountID</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeAccountPublic" class="tsd-kind-icon">encode<wbr/>Account<wbr/>Public</a></li><li class="tsd-kind-function"><a href="modules.html#encodeForMultiSigning" class="tsd-kind-icon">encode<wbr/>For<wbr/>Multi<wbr/>Signing</a></li><li class="tsd-kind-function"><a href="modules.html#encodeForSigning" class="tsd-kind-icon">encode<wbr/>For<wbr/>Signing</a></li><li class="tsd-kind-function"><a href="modules.html#encodeForSigningClaim" class="tsd-kind-icon">encode<wbr/>For<wbr/>Signing<wbr/>Claim</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeNodePublic" class="tsd-kind-icon">encode<wbr/>Node<wbr/>Public</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeSeed" class="tsd-kind-icon">encode<wbr/>Seed</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#encodeXAddress" class="tsd-kind-icon">encodeXAddress</a></li><li class="tsd-kind-function"><a href="modules.html#getBalanceChanges" class="tsd-kind-icon">get<wbr/>Balance<wbr/>Changes</a></li><li class="tsd-kind-function"><a href="modules.html#hasNextPage" class="tsd-kind-icon">has<wbr/>Next<wbr/>Page</a></li><li class="tsd-kind-function"><a href="modules.html#isValidAddress" class="tsd-kind-icon">is<wbr/>Valid<wbr/>Address</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#isValidClassicAddress" class="tsd-kind-icon">is<wbr/>Valid<wbr/>Classic<wbr/>Address</a></li><li class="tsd-kind-function"><a href="modules.html#isValidSecret" class="tsd-kind-icon">is<wbr/>Valid<wbr/>Secret</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#isValidXAddress" class="tsd-kind-icon">is<wbr/>ValidXAddress</a></li><li class="tsd-kind-function"><a href="modules.html#isoTimeToRippleTime" class="tsd-kind-icon">iso<wbr/>Time<wbr/>To<wbr/>Ripple<wbr/>Time</a></li><li class="tsd-kind-function"><a href="modules.html#multisign" class="tsd-kind-icon">multisign</a></li><li class="tsd-kind-function"><a href="modules.html#parseAccountRootFlags" class="tsd-kind-icon">parse<wbr/>Account<wbr/>Root<wbr/>Flags</a></li><li class="tsd-kind-function"><a href="modules.html#percentToQuality" class="tsd-kind-icon">percent<wbr/>To<wbr/>Quality</a></li><li class="tsd-kind-function"><a href="modules.html#percentToTransferRate" class="tsd-kind-icon">percent<wbr/>To<wbr/>Transfer<wbr/>Rate</a></li><li class="tsd-kind-function"><a href="modules.html#qualityToDecimal" class="tsd-kind-icon">quality<wbr/>To<wbr/>Decimal</a></li><li class="tsd-kind-function"><a href="modules.html#rippleTimeToISOTime" class="tsd-kind-icon">ripple<wbr/>Time<wbr/>ToISOTime</a></li><li class="tsd-kind-function"><a href="modules.html#rippleTimeToUnixTime" class="tsd-kind-icon">ripple<wbr/>Time<wbr/>To<wbr/>Unix<wbr/>Time</a></li><li class="tsd-kind-function"><a href="modules.html#setTransactionFlagsToNumber" class="tsd-kind-icon">set<wbr/>Transaction<wbr/>Flags<wbr/>To<wbr/>Number</a></li><li class="tsd-kind-function"><a href="modules.html#signPaymentChannelClaim" class="tsd-kind-icon">sign<wbr/>Payment<wbr/>Channel<wbr/>Claim</a></li><li class="tsd-kind-function"><a href="modules.html#transferRateToDecimal" class="tsd-kind-icon">transfer<wbr/>Rate<wbr/>To<wbr/>Decimal</a></li><li class="tsd-kind-function"><a href="modules.html#unixTimeToRippleTime" class="tsd-kind-icon">unix<wbr/>Time<wbr/>To<wbr/>Ripple<wbr/>Time</a></li><li class="tsd-kind-function"><a href="modules.html#validate" class="tsd-kind-icon">validate</a></li><li class="tsd-kind-function"><a href="modules.html#verifyPaymentChannelClaim" class="tsd-kind-icon">verify<wbr/>Payment<wbr/>Channel<wbr/>Claim</a></li><li class="tsd-kind-function"><a href="modules.html#verifySignature" class="tsd-kind-icon">verify<wbr/>Signature</a></li><li class="tsd-kind-function tsd-is-external"><a href="modules.html#xAddressToClassicAddress" class="tsd-kind-icon">x<wbr/>Address<wbr/>To<wbr/>Classic<wbr/>Address</a></li><li class="tsd-kind-function"><a href="modules.html#xrpToDrops" class="tsd-kind-icon">xrp<wbr/>To<wbr/>Drops</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><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> |