ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-12 16:45:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fc6f85e4510073e9c8996a014aab66536b6f7233
xahau.js/docs/interfaces/LedgerEntry.Ledger.html

43 lines
39 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>Ledger | 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="../modules/LedgerEntry.html">LedgerEntry</a></li><li><a href="LedgerEntry.Ledger.html">Ledger</a></li></ul><h1>Interface Ledger</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>A ledger is a block of transactions and shared state data. It has a unique
header that describes its contents using cryptographic hashes.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Ledger</span></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="LedgerEntry.Ledger.html#accountState" class="tsd-kind-icon">account<wbr/>State</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#account_hash" class="tsd-kind-icon">account_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_flags" class="tsd-kind-icon">close_<wbr/>flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_time" class="tsd-kind-icon">close_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_time_human" class="tsd-kind-icon">close_<wbr/>time_<wbr/>human</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_time_resolution" class="tsd-kind-icon">close_<wbr/>time_<wbr/>resolution</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#closed" class="tsd-kind-icon">closed</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#parent_close_time" class="tsd-kind-icon">parent_<wbr/>close_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#parent_hash" class="tsd-kind-icon">parent_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#total_coins" class="tsd-kind-icon">total_<wbr/>coins</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#transaction_hash" class="tsd-kind-icon">transaction_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.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="accountState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> account<wbr/>State<a href="#accountState" 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">account<wbr/>State<span class="tsd-signature-symbol">?:</span> <a href="../modules/LedgerEntry.html#LedgerEntry-1" class="tsd-signature-type" data-tsd-kind="Type alias">LedgerEntry</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/ledger/Ledger.ts#L15">packages/xrpl/src/models/ledger/Ledger.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>All the state information in this ledger.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="account_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link">account_<wbr/>hash<a href="#account_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">account_<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/ledger/Ledger.ts#L13">packages/xrpl/src/models/ledger/Ledger.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The SHA-512Half of this ledger&#39;s state tree information.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="close_flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link">close_<wbr/>flags<a href="#close_flags" 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">close_<wbr/>flags<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/417978e1/packages/xrpl/src/models/ledger/Ledger.ts#L17">packages/xrpl/src/models/ledger/Ledger.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A bit-map of flags relating to the closing of this ledger.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="close_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link">close_<wbr/>time<a href="#close_time" 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">close_<wbr/>time<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/417978e1/packages/xrpl/src/models/ledger/Ledger.ts#L23">packages/xrpl/src/models/ledger/Ledger.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The approximate time this ledger version closed, as the number of seconds
since the Ripple Epoch of 2000-01-01 00:00:00. This value is rounded based
on the close_time_resolution.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="close_time_human" class="tsd-anchor"></a><h3 class="tsd-anchor-link">close_<wbr/>time_<wbr/>human<a href="#close_time_human" 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">close_<wbr/>time_<wbr/>human<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/ledger/Ledger.ts#L28">packages/xrpl/src/models/ledger/Ledger.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The approximate time this ledger was closed, in human-readable format.
Always uses the UTC time zone.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="close_time_resolution" class="tsd-anchor"></a><h3 class="tsd-anchor-link">close_<wbr/>time_<wbr/>resolution<a href="#close_time_resolution" 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">close_<wbr/>time_<wbr/>resolution<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/417978e1/packages/xrpl/src/models/ledger/Ledger.ts#L33">packages/xrpl/src/models/ledger/Ledger.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>An integer in the range [2,120] indicating the maximum number of seconds
by which the close_time could be rounded.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="closed" class="tsd-anchor"></a><h3 class="tsd-anchor-link">closed<a href="#closed" 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">closed<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/ledger/Ledger.ts#L35">packages/xrpl/src/models/ledger/Ledger.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether or not this ledger has been closed.</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">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/ledger/Ledger.ts#L40">packages/xrpl/src/models/ledger/Ledger.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The SHA-512Half of this ledger version. This serves as a unique identifier
for this ledger and all its contents.</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">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">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/ledger/Ledger.ts#L45">packages/xrpl/src/models/ledger/Ledger.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ledger index of the ledger. Some API methods display this as a quoted
integer; some display it as a native JSON number.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parent_close_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link">parent_<wbr/>close_<wbr/>time<a href="#parent_close_time" 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">parent_<wbr/>close_<wbr/>time<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/417978e1/packages/xrpl/src/models/ledger/Ledger.ts#L47">packages/xrpl/src/models/ledger/Ledger.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The approximate time at which the previous ledger was closed.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="parent_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link">parent_<wbr/>hash<a href="#parent_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">parent_<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/ledger/Ledger.ts#L52">packages/xrpl/src/models/ledger/Ledger.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Unique identifying hash of the ledger that came immediately before this
one.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="total_coins" class="tsd-anchor"></a><h3 class="tsd-anchor-link">total_<wbr/>coins<a href="#total_coins" 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">total_<wbr/>coins<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/ledger/Ledger.ts#L54">packages/xrpl/src/models/ledger/Ledger.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total number of XRP drops in the network, as a quoted integer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transaction_hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link">transaction_<wbr/>hash<a href="#transaction_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">transaction_<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/ledger/Ledger.ts#L56">packages/xrpl/src/models/ledger/Ledger.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Hash of the transaction information included in this ledger, as hex.</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-symbol">(</span><span class="tsd-signature-symbol">(</span><a href="AccountDelete.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountDelete</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="AccountSet.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountSet</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="CheckCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCancel</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="CheckCash.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCash</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="CheckCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">CheckCreate</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="EscrowCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCancel</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="EscrowCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowCreate</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="EscrowFinish.html" class="tsd-signature-type" data-tsd-kind="Interface">EscrowFinish</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="NFTokenAcceptOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenAcceptOffer</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="NFTokenBurn.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenBurn</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="NFTokenCancelOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenCancelOffer</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="NFTokenCreateOffer.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenCreateOffer</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="NFTokenMint.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenMint</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="OfferCancel.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCancel</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="OfferCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">OfferCreate</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="Payment.html" class="tsd-signature-type" data-tsd-kind="Interface">Payment</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="PaymentChannelClaim.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelClaim</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="PaymentChannelCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelCreate</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="PaymentChannelFund.html" class="tsd-signature-type" data-tsd-kind="Interface">PaymentChannelFund</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="SetRegularKey.html" class="tsd-signature-type" data-tsd-kind="Interface">SetRegularKey</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="SignerListSet.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerListSet</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="TicketCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">TicketCreate</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">(</span><a href="TrustSet.html" class="tsd-signature-type" data-tsd-kind="Interface">TrustSet</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>metaData<span class="tsd-signature-symbol">?: </span><a href="TransactionMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">TransactionMetadata</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/417978e1/packages/xrpl/src/models/ledger/Ledger.ts#L64">packages/xrpl/src/models/ledger/Ledger.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Transactions applied in this ledger version. By default, members are the
transactions&#39; identifying Hash strings. If the request specified expand as
true, members are full representations of the transactions instead, in
either JSON or binary depending on whether the request specified binary
as true.</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="current 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 tsd-parent-kind-namespace"><a href="LedgerEntry.Ledger.html" class="tsd-kind-icon">Ledger</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#accountState" class="tsd-kind-icon">account<wbr/>State</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#account_hash" class="tsd-kind-icon">account_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_flags" class="tsd-kind-icon">close_<wbr/>flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_time" class="tsd-kind-icon">close_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_time_human" class="tsd-kind-icon">close_<wbr/>time_<wbr/>human</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#close_time_resolution" class="tsd-kind-icon">close_<wbr/>time_<wbr/>resolution</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#closed" class="tsd-kind-icon">closed</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#parent_close_time" class="tsd-kind-icon">parent_<wbr/>close_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#parent_hash" class="tsd-kind-icon">parent_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#total_coins" class="tsd-kind-icon">total_<wbr/>coins</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.html#transaction_hash" class="tsd-kind-icon">transaction_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.Ledger.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>
Reference in New Issue View Git Blame Copy Permalink