ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-05 05:15:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6d3b2d3a9e2ebcf68cd90cdb10d4e4a7c9d73004
xahau.js/docs/interfaces/BookOffersRequest.html
Jackson Mills 13587e563a Update history.md with latest changes and ran docgen (#1988) 
* Update history.md with latest changes

* Ran docgen

* Add unreleased sections
2022-05-02 10:37:39 -07:00

30 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BookOffersRequest | 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.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="BookOffersRequest.html">BookOffersRequest</a></li></ul><h1>Interface BookOffersRequest</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>The book_offers method retrieves a list of offers, also known as the order.
Book, between two currencies. Returns an <a href="BookOffersResponse.html">BookOffersResponse</a>.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">BookOffersRequest</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="BookOffersRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker" class="tsd-kind-icon">taker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_gets" class="tsd-kind-icon">taker_<wbr/>gets</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_pays" class="tsd-kind-icon">taker_<wbr/>pays</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version<a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The API version to use. If omitted, use version 1.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3 class="tsd-anchor-link">command<a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;book_offers&quot;</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/bookOffers.ts#L18">packages/xrpl/src/models/methods/bookOffers.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A unique value to identify this request. The response to this request uses
the same id field. This way, even if responses arrive out of order, you
know which request prompted which response.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>hash<a href="#ledger_hash" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/bookOffers.ts#L20">packages/xrpl/src/models/methods/bookOffers.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A 20-byte hex string for the ledger version to use.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr/>index<a href="#ledger_index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/bookOffers.ts#L25">packages/xrpl/src/models/methods/bookOffers.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ledger index of the ledger to use, or a shortcut string to choose a
ledger automatically.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="limit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> limit<a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/bookOffers.ts#L31">packages/xrpl/src/models/methods/bookOffers.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>If provided, the server does not provide more than this many offers in the
results. The total number of results returned may be fewer than the limit,
because the server omits unfunded offers.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> taker<a href="#taker" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">taker<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/bookOffers.ts#L36">packages/xrpl/src/models/methods/bookOffers.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The Address of an account to use as a perspective. Unfunded offers placed
by this account are always included in the response.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker_gets" class="tsd-anchor"></a><h3 class="tsd-anchor-link">taker_<wbr/>gets<a href="#taker_gets" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">taker_<wbr/>gets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TakerAmount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/bookOffers.ts#L42">packages/xrpl/src/models/methods/bookOffers.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specification of which currency the account taking the offer would
receive, as an object with currency and issuer fields (omit issuer for
XRP), like currency amounts.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker_pays" class="tsd-anchor"></a><h3 class="tsd-anchor-link">taker_<wbr/>pays<a href="#taker_pays" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">taker_<wbr/>pays<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TakerAmount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/30d53b51/packages/xrpl/src/models/methods/bookOffers.ts#L48">packages/xrpl/src/models/methods/bookOffers.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specification of which currency the account taking the offer would pay, as
an object with currency and issuer fields (omit issuer for XRP), like
currency amounts.</p>
</div></div></section></section></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><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="current tsd-kind-interface"><a href="BookOffersRequest.html" class="tsd-kind-icon">Book<wbr/>Offers<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="BookOffersRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffersRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#limit" class="tsd-kind-icon">limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker" class="tsd-kind-icon">taker</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_gets" class="tsd-kind-icon">taker_<wbr/>gets</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffersRequest.html#taker_pays" class="tsd-kind-icon">taker_<wbr/>pays</a></li></ul></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>
Reference in New Issue View Git Blame Copy Permalink