mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-06 17:27:59 +00:00
23c5938591
We renamed the Google Group to xrpl-announce. In the future, the same list may be used for releases of other client libraries as well. It's a small list (less than 60 subscribers) and not very noisy, so it should be okay to include release announcements about libraries in other languages, especially since many developers are polyglots. Of course, we hope the list will grow in the future.
623 lines
35 KiB
HTML
623 lines
35 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>ripple-lib</title>
|
|
<meta name="description" content="Documentation for ripple-lib">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="assets/css/main.css">
|
|
<script async src="assets/js/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-index="assets/js/search.json" data-base=".">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</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">ripple-lib</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>ripple-lib</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="#ripple-lib-rippleapi" id="ripple-lib-rippleapi" style="color: inherit; text-decoration: none;">
|
|
<h1>ripple-lib (RippleAPI)</h1>
|
|
</a>
|
|
<p>A JavaScript/TypeScript API for interacting with the XRP Ledger</p>
|
|
<p><a href="https://www.npmjs.org/package/ripple-lib"><img src="https://nodei.co/npm/ripple-lib.png" alt="NPM"></a></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="https://xrpl.org/rippleapi-reference.html">➡️ Reference Documentation</a></h2>
|
|
</a>
|
|
<p>See the full reference documentation on the XRP Ledger Dev Portal.</p>
|
|
<a href="#➡️-applications-and-projects" id="➡️-applications-and-projects" style="color: inherit; text-decoration: none;">
|
|
<h2><a href="APPLICATIONS.md">➡️ Applications and Projects</a></h2>
|
|
</a>
|
|
<p>What is ripple-lib used for? The applications on the list linked above use <code>ripple-lib</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>Connect to a <code>rippled</code> server from Node.js or a web browser</li>
|
|
<li>Helpers for creating requests and parsing responses for the <a href="https://developers.ripple.com/rippled-api.html">rippled API</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. 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>See also: <a href="https://xrpl.org/get-started-with-rippleapi-for-javascript.html">RippleAPI Beginners Guide</a></p>
|
|
<p>In an existing project (with <code>package.json</code>), install <code>ripple-lib</code>:</p>
|
|
<pre><code><span style="color: #001080">$</span><span style="color: #000000"> </span><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> </span><span style="color: #001080">ripple</span><span style="color: #000000">-</span><span style="color: #001080">lib</span>
|
|
</code></pre>
|
|
<p>Then see the <a href="#documentation">documentation</a>.</p>
|
|
<a href="#using-ripple-lib-with-react-native" id="using-ripple-lib-with-react-native" style="color: inherit; text-decoration: none;">
|
|
<h3>Using ripple-lib with React Native</h3>
|
|
</a>
|
|
<p>If you want to use <code>ripple-lib</code> with React Native you will need to have some of the NodeJS modules available. 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>npm</code> as well):</p>
|
|
<pre><code class="language-shell"><span style="color: #000000">npm install react-native-crypto</span>
|
|
<span style="color: #000000">npm install ripple-lib</span>
|
|
<span style="color: #008000"># install peer deps</span>
|
|
<span style="color: #000000">npm install react-native-randombytes</span>
|
|
<span style="color: #008000"># install latest rn-nodeify</span>
|
|
<span style="color: #000000">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 style="color: #008000"># install node core shims and recursively hack package.json files</span>
|
|
<span style="color: #008000"># in ./node_modules to add/update the "browser"/"react-native" field with relevant mappings</span>
|
|
<span style="color: #000000">./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 style="color: #008000">// If using the crypto shim, uncomment the following line to ensure</span>
|
|
<span style="color: #008000">// crypto is loaded first, so it can populate global.crypto</span>
|
|
<span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">'crypto'</span><span style="color: #000000">)</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 style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #A31515">'./shim'</span>
|
|
<span style="color: #000000">...</span>
|
|
</code></pre>
|
|
<a href="#using-ripple-lib-with-deno" id="using-ripple-lib-with-deno" style="color: inherit; text-decoration: none;">
|
|
<h3>Using ripple-lib 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>ripple-lib</code> with Deno:</p>
|
|
<pre><code class="language-javascript"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">ripple</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'https://dev.jspm.io/npm:ripple-lib'</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> () </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">api</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> (</span><span style="color: #001080">ripple</span><span style="color: #000000"> </span><span style="color: #AF00DB">as</span><span style="color: #000000"> </span><span style="color: #267F99">any</span><span style="color: #000000">).</span><span style="color: #795E26">RippleAPI</span><span style="color: #000000">({ </span><span style="color: #001080">server:</span><span style="color: #000000"> </span><span style="color: #A31515">'wss://s.altnet.rippletest.net:51233'</span><span style="color: #000000"> });</span>
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">address</span><span style="color: #000000"> = </span><span style="color: #A31515">'rH8NxV12EuV...khfJ5uw9kT'</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #001080">api</span><span style="color: #000000">.</span><span style="color: #795E26">connect</span><span style="color: #000000">().</span><span style="color: #795E26">then</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">api</span><span style="color: #000000">.</span><span style="color: #795E26">getBalances</span><span style="color: #000000">(</span><span style="color: #001080">address</span><span style="color: #000000">).</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">balances</span><span style="color: #000000">: </span><span style="color: #267F99">any</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #267F99">JSON</span><span style="color: #000000">.</span><span style="color: #795E26">stringify</span><span style="color: #000000">(</span><span style="color: #001080">balances</span><span style="color: #000000">, </span><span style="color: #0000FF">null</span><span style="color: #000000">, </span><span style="color: #098658">2</span><span style="color: #000000">));</span>
|
|
<span style="color: #000000"> });</span>
|
|
<span style="color: #000000"> });</span>
|
|
<span style="color: #000000">})();</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-with-rippleapi-for-javascript.html">RippleAPI Beginners Guide</a></li>
|
|
<li><a href="https://xrpl.org/rippleapi-reference.html">RippleAPI Full Reference Documentation</a> (<a href="https://github.com/ripple/ripple-lib/blob/develop/docs/index.md">in this repo</a>)</li>
|
|
<li><a href="https://github.com/ripple/ripple-lib/tree/develop/docs/samples">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 xrpl.js (ripple-lib) 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="#development" id="development" style="color: inherit; text-decoration: none;">
|
|
<h2>Development</h2>
|
|
</a>
|
|
<p>To build the library for Node.js and the browser:</p>
|
|
<pre><code><span style="color: #001080">$</span><span style="color: #000000"> </span><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">run</span><span style="color: #000000"> </span><span style="color: #001080">build</span>
|
|
</code></pre>
|
|
<p>The TypeScript compiler will <a href="./tsconfig.json#L7">output</a> the resulting JS files in <code>./dist/npm/</code>.</p>
|
|
<p>webpack will output the resulting JS files in <code>./build/</code>.</p>
|
|
<p>For details, see the <code>scripts</code> in <code>package.json</code>.</p>
|
|
<a href="#running-tests" id="running-tests" style="color: inherit; text-decoration: none;">
|
|
<h2>Running Tests</h2>
|
|
</a>
|
|
<a href="#unit-tests" id="unit-tests" style="color: inherit; text-decoration: none;">
|
|
<h3>Unit Tests</h3>
|
|
</a>
|
|
<ol>
|
|
<li>Clone the repository</li>
|
|
<li><code>cd</code> into the repository and install dependencies with <code>npm install</code></li>
|
|
<li><code>npm test</code></li>
|
|
</ol>
|
|
<a href="#linting" id="linting" style="color: inherit; text-decoration: none;">
|
|
<h3>Linting</h3>
|
|
</a>
|
|
<p>Run <code>npm run lint</code> to lint the code with <code>eslint</code>.</p>
|
|
<a href="#generating-documentation" id="generating-documentation" style="color: inherit; text-decoration: none;">
|
|
<h2>Generating Documentation</h2>
|
|
</a>
|
|
<p>Do not edit <code>./docs/index.md</code> directly because it is a generated file.</p>
|
|
<p>Instead, edit the appropriate <code>.md.ejs</code> files in <code>./docs/src/</code>.</p>
|
|
<p>If you make changes to the JSON schemas, fixtures, or documentation sources, update the documentation by running <code>npm run docgen</code>.</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://xrpl.org/rippleapi-reference.html">RippleAPI Reference</a> - XRP Ledger Dev Portal</li>
|
|
<li><a href="https://xrpl.org/">XRP Ledger Dev Portal</a></li>
|
|
</ul>
|
|
<p> <a href="https://travis-ci.org/ripple/ripple-lib"><img src="https://travis-ci.org/ripple/ripple-lib.svg?branch=master" alt="Build Status"></a></p>
|
|
</div>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="modules.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-reference">
|
|
<a href="modules.html#deriveXAddress" class="tsd-kind-icon">deriveXAddress</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/Wallet.html" class="tsd-kind-icon">Wallet</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/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/AccountTxRequest.html" class="tsd-kind-icon">Account<wbr>TxRequest</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/AccountTxResponse.html" class="tsd-kind-icon">Account<wbr>TxResponse</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/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/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/FormattedOrderCancellation.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/FormattedOrderCancellationTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Cancellation<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/FormattedOrderTransaction.html" class="tsd-kind-icon">Formatted<wbr>Order<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/FormattedPayment.html" class="tsd-kind-icon">Formatted<wbr>Payment</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/FormattedPaymentTransaction.html" class="tsd-kind-icon">Formatted<wbr>Payment<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/FormattedSettingsTransaction.html" class="tsd-kind-icon">Formatted<wbr>Settings<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/FormattedTrustlineTransaction.html" class="tsd-kind-icon">Formatted<wbr>Trustline<wbr>Transaction</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/Instructions.html" class="tsd-kind-icon">Instructions</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/KeyPair.html" class="tsd-kind-icon">Key<wbr>Pair</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/Ledger.html" class="tsd-kind-icon">Ledger</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/LedgerClosedEvent.html" class="tsd-kind-icon">Ledger<wbr>Closed<wbr>Event</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/OfferCreateTransaction.html" class="tsd-kind-icon">Offer<wbr>Create<wbr>Transaction</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/Outcome.html" class="tsd-kind-icon">Outcome</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/PathFindStream.html" class="tsd-kind-icon">Path<wbr>Find<wbr>Stream</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/Prepare.html" class="tsd-kind-icon">Prepare</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/SettingsTransaction.html" class="tsd-kind-icon">Settings<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/SignOptions.html" class="tsd-kind-icon">Sign<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/Submit.html" class="tsd-kind-icon">Submit</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/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/TransactionJSON.html" class="tsd-kind-icon">TransactionJSON</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/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#FormattedTransactionType" class="tsd-kind-icon">Formatted<wbr>Transaction<wbr>Type</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-property tsd-is-external">
|
|
<a href="modules.html#deriveAddress" class="tsd-kind-icon">derive<wbr>Address</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-function">
|
|
<a href="modules.html#ISOTimeToRippleTime" class="tsd-kind-icon">ISOTime<wbr>ToRipple<wbr>Time</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeAccountRootIndex" class="tsd-kind-icon">compute<wbr>Account<wbr>Root<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeBinaryTransactionHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeBinaryTransactionSigningHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeEscrowHash" class="tsd-kind-icon">compute<wbr>Escrow<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeLedgerHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeLedgerHeaderHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeOfferIndex" class="tsd-kind-icon">compute<wbr>Offer<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computePaymentChannelHash" class="tsd-kind-icon">compute<wbr>Payment<wbr>Channel<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeSignerListIndex" class="tsd-kind-icon">compute<wbr>Signer<wbr>List<wbr>Index</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeStateTreeHash" class="tsd-kind-icon">compute<wbr>State<wbr>Tree<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeTransactionHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeTransactionTreeHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Tree<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#computeTrustlineHash" class="tsd-kind-icon">compute<wbr>Trustline<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#convertKeysFromSnakeCaseToCamelCase" class="tsd-kind-icon">convert<wbr>Keys<wbr>From<wbr>Snake<wbr>Case<wbr>ToCamel<wbr>Case</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#dropsToXrp" class="tsd-kind-icon">drops<wbr>ToXrp</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#generateXAddress" class="tsd-kind-icon">generateXAddress</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-has-type-parameter">
|
|
<a href="modules.html#removeUndefined" class="tsd-kind-icon">remove<wbr>Undefined</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#signPaymentChannelClaim" class="tsd-kind-icon">sign<wbr>Payment<wbr>Channel<wbr>Claim</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="modules.html#toRippledAmount" class="tsd-kind-icon">to<wbr>Rippled<wbr>Amount</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#xrpToDrops" class="tsd-kind-icon">xrp<wbr>ToDrops</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-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>
|
|
</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/js/main.js"></script>
|
|
</body>
|
|
</html>
|