mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-11 16:25:48 +00:00
42 lines
25 KiB
HTML
42 lines
25 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LedgerRequest | 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="LedgerRequest.html">LedgerRequest</a></li></ul><h1>Interface LedgerRequest</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>Retrieve information about the public ledger. Expects a response in the form
|
|
of a <a href="LedgerResponse.html">LedgerResponse</a>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ledger</span><span class="hl-1">: </span><span class="hl-9">LedgerRequest</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-7">"id"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-8">14</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">"command"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-7">"ledger"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">"ledger_index"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-7">"validated"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">"full"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">"accounts"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">"transactions"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">"expand"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">"owner_funds"</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-0">false</span><br/><span class="hl-1">}</span>
|
|
</code></pre>
|
|
</dd></dl></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">LedgerRequest</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"><a href="LedgerRequest.html#accounts" class="tsd-kind-icon">accounts</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#expand" class="tsd-kind-icon">expand</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#full" class="tsd-kind-icon">full</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#owner_funds" class="tsd-kind-icon">owner_<wbr/>funds</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#queue" class="tsd-kind-icon">queue</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#transactions" class="tsd-kind-icon">transactions</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"><a id="accounts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> accounts<a href="#accounts" 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">accounts<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L46">packages/xrpl/src/models/methods/ledger.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Admin required. If true, return information on accounts in the ledger.
|
|
Ignored if you did not specify a ledger version. Defaults to false.</p>
|
|
</div></div></section><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/417978e1/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"><a id="binary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> binary<a href="#binary" 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">binary<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L70">packages/xrpl/src/models/methods/ledger.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, and transactions and expand are both also true, return
|
|
transaction information in binary format (hexadecimal string) instead of
|
|
JSON format.</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">"ledger"</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L29">packages/xrpl/src/models/methods/ledger.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="expand" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> expand<a href="#expand" 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">expand<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L58">packages/xrpl/src/models/methods/ledger.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Provide full JSON-formatted information for transaction/account
|
|
information instead of only hashes. Defaults to false. Ignored unless you
|
|
request transactions, accounts, or both.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="full" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> full<a href="#full" 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">full<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L41">packages/xrpl/src/models/methods/ledger.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Admin required If true, return full information on the entire ledger.
|
|
Ignored if you did not specify a ledger version. Defaults to false.</p>
|
|
</div></div></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/417978e1/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/417978e1/packages/xrpl/src/models/methods/ledger.ts#L31">packages/xrpl/src/models/methods/ledger.ts:31</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/417978e1/packages/xrpl/src/models/methods/ledger.ts#L36">packages/xrpl/src/models/methods/ledger.ts:36</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="owner_funds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> owner_<wbr/>funds<a href="#owner_funds" 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">owner_<wbr/>funds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L64">packages/xrpl/src/models/methods/ledger.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, include owner_funds field in the metadata of OfferCreate
|
|
transactions in the response. Defaults to false. Ignored unless
|
|
transactions are included and expand is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="queue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> queue<a href="#queue" 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">queue<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L75">packages/xrpl/src/models/methods/ledger.ts:75</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, and the command is requesting the current ledger, includes an
|
|
array of queued transactions in the results.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transactions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> transactions<a href="#transactions" 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">transactions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/methods/ledger.ts#L52">packages/xrpl/src/models/methods/ledger.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, return information on transactions in the specified ledger
|
|
version. Defaults to false. Ignored if you did not specify a ledger
|
|
version.</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="LedgerRequest.html" class="tsd-kind-icon">Ledger<wbr/>Request</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#accounts" class="tsd-kind-icon">accounts</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#expand" class="tsd-kind-icon">expand</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#full" class="tsd-kind-icon">full</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#owner_funds" class="tsd-kind-icon">owner_<wbr/>funds</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#queue" class="tsd-kind-icon">queue</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerRequest.html#transactions" class="tsd-kind-icon">transactions</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> |