mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 12:15:51 +00:00
build: update package.json version for release (#1755)
* build: update xrpl.js for release
This commit is contained in:
Nathan Nichols
@@ -1,359 +1,32 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>LedgerStream | xrpl</title>
|
||||
<meta name="description" content="Documentation for xrpl">
|
||||
<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">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="LedgerStream.html">LedgerStream</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface LedgerStream</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 <code>ledger</code> stream only sends <code>ledgerClosed</code> messages when the consensus
|
||||
process declares a new validated ledger. The message identifies the ledger
|
||||
And provides some information about its contents.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="tsd-signature-type">BaseStream</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">LedgerStream</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="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr>base</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr>ref</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr>time</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr>count</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerStream.html#type" class="tsd-kind-icon">type</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr>ledgers</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 name="fee_base" class="tsd-anchor"></a>
|
||||
<h3>fee_<wbr>base</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">fee_<wbr>base<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/615504db/src/models/methods/subscribe.ts#L95">src/models/methods/subscribe.ts:95</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The reference transaction cost as of this ledger version, in drops of XRP.
|
||||
If this ledger version includes a SetFee pseudo-transaction the new.
|
||||
Transaction cost applies starting with the following ledger version.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="fee_ref" class="tsd-anchor"></a>
|
||||
<h3>fee_<wbr>ref</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">fee_<wbr>ref<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/615504db/src/models/methods/subscribe.ts#L97">src/models/methods/subscribe.ts:97</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The reference transaction cost in "fee units".</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="ledger_hash" class="tsd-anchor"></a>
|
||||
<h3>ledger_<wbr>hash</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/615504db/src/models/methods/subscribe.ts#L99">src/models/methods/subscribe.ts:99</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The identifying hash of the ledger version that was closed.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="ledger_index" class="tsd-anchor"></a>
|
||||
<h3>ledger_<wbr>index</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<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/615504db/src/models/methods/subscribe.ts#L101">src/models/methods/subscribe.ts:101</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The ledger index of the ledger that was closed.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="ledger_time" class="tsd-anchor"></a>
|
||||
<h3>ledger_<wbr>time</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ledger_<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/615504db/src/models/methods/subscribe.ts#L103">src/models/methods/subscribe.ts:103</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The time this ledger was closed, in seconds since the Ripple Epoch.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="reserve_base" class="tsd-anchor"></a>
|
||||
<h3>reserve_<wbr>base</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">reserve_<wbr>base<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/615504db/src/models/methods/subscribe.ts#L109">src/models/methods/subscribe.ts:109</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The minimum reserve, in drops of XRP, that is required for an account. If
|
||||
this ledger version includes a SetFee pseudo-transaction the new base reserve
|
||||
applies starting with the following ledger version.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="reserve_inc" class="tsd-anchor"></a>
|
||||
<h3>reserve_<wbr>inc</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">reserve_<wbr>inc<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/615504db/src/models/methods/subscribe.ts#L115">src/models/methods/subscribe.ts:115</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The owner reserve for each object an account owns in the ledger, in drops
|
||||
of XRP. If the ledger includes a SetFee pseudo-transaction the new owner
|
||||
reserve applies after this ledger.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="txn_count" class="tsd-anchor"></a>
|
||||
<h3>txn_<wbr>count</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">txn_<wbr>count<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/615504db/src/models/methods/subscribe.ts#L117">src/models/methods/subscribe.ts:117</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Number of new transactions included in this ledger version.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
||||
<a name="type" class="tsd-anchor"></a>
|
||||
<h3>type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ledgerClosed"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides BaseStream.type</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L89">src/models/methods/subscribe.ts:89</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="validated_ledgers" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> validated_<wbr>ledgers</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">validated_<wbr>ledgers<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/615504db/src/models/methods/subscribe.ts#L124">src/models/methods/subscribe.ts:124</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Range of ledgers that the server has available. This may be a disjoint
|
||||
sequence such as 24900901-24900984,24901116-24901158. This field is not
|
||||
returned if the server is not connected to the network, or if it is
|
||||
connected but has not yet obtained a ledger from the network.</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>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
<a href="LedgerStream.html" class="tsd-kind-icon">Ledger<wbr>Stream</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr>base</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr>ref</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr>hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr>index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr>time</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr>base</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr>inc</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr>count</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
||||
<a href="LedgerStream.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr>ledgers</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</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>
|
||||
</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>
|
||||
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>LedgerStream | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="LedgerStream.html">LedgerStream</a></li></ul><h1>Interface LedgerStream</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 <code>ledger</code> stream only sends <code>ledgerClosed</code> messages when the consensus
|
||||
process declares a new validated ledger. The message identifies the ledger
|
||||
And provides some information about its contents.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseStream</span><ul class="tsd-hierarchy"><li><span class="target">LedgerStream</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="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr/>ref</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr/>inc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr/>ledgers</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 name="fee_base" class="tsd-anchor"></a><h3>fee_<wbr/>base</h3><div class="tsd-signature tsd-kind-icon">fee_<wbr/>base<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/922be621/src/models/methods/subscribe.ts#L98">src/models/methods/subscribe.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The reference transaction cost as of this ledger version, in drops of XRP.
|
||||
If this ledger version includes a SetFee pseudo-transaction the new.
|
||||
Transaction cost applies starting with the following ledger version.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="fee_ref" class="tsd-anchor"></a><h3>fee_<wbr/>ref</h3><div class="tsd-signature tsd-kind-icon">fee_<wbr/>ref<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/922be621/src/models/methods/subscribe.ts#L100">src/models/methods/subscribe.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The reference transaction cost in "fee units".</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ledger_hash" class="tsd-anchor"></a><h3>ledger_<wbr/>hash</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/922be621/src/models/methods/subscribe.ts#L102">src/models/methods/subscribe.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The identifying hash of the ledger version that was closed.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ledger_index" class="tsd-anchor"></a><h3>ledger_<wbr/>index</h3><div class="tsd-signature tsd-kind-icon">ledger_<wbr/>index<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/922be621/src/models/methods/subscribe.ts#L104">src/models/methods/subscribe.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The ledger index of the ledger that was closed.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="ledger_time" class="tsd-anchor"></a><h3>ledger_<wbr/>time</h3><div class="tsd-signature tsd-kind-icon">ledger_<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/922be621/src/models/methods/subscribe.ts#L106">src/models/methods/subscribe.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The time this ledger was closed, in seconds since the Ripple Epoch.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="reserve_base" class="tsd-anchor"></a><h3>reserve_<wbr/>base</h3><div class="tsd-signature tsd-kind-icon">reserve_<wbr/>base<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/922be621/src/models/methods/subscribe.ts#L112">src/models/methods/subscribe.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The minimum reserve, in drops of XRP, that is required for an account. If
|
||||
this ledger version includes a SetFee pseudo-transaction the new base reserve
|
||||
applies starting with the following ledger version.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="reserve_inc" class="tsd-anchor"></a><h3>reserve_<wbr/>inc</h3><div class="tsd-signature tsd-kind-icon">reserve_<wbr/>inc<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/922be621/src/models/methods/subscribe.ts#L118">src/models/methods/subscribe.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The owner reserve for each object an account owns in the ledger, in drops
|
||||
of XRP. If the ledger includes a SetFee pseudo-transaction the new owner
|
||||
reserve applies after this ledger.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="txn_count" class="tsd-anchor"></a><h3>txn_<wbr/>count</h3><div class="tsd-signature tsd-kind-icon">txn_<wbr/>count<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/922be621/src/models/methods/subscribe.ts#L120">src/models/methods/subscribe.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Number of new transactions included in this ledger version.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a name="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ledgerClosed"</span></div><aside class="tsd-sources"><p>Overrides BaseStream.type</p><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/methods/subscribe.ts#L92">src/models/methods/subscribe.ts:92</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="validated_ledgers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> validated_<wbr/>ledgers</h3><div class="tsd-signature tsd-kind-icon">validated_<wbr/>ledgers<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/922be621/src/models/methods/subscribe.ts#L127">src/models/methods/subscribe.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Range of ledgers that the server has available. This may be a disjoint
|
||||
sequence such as 24900901-24900984,24901116-24901158. This field is not
|
||||
returned if the server is not connected to the network, or if it is
|
||||
connected but has not yet obtained a ledger from the network.</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="LedgerStream.html" class="tsd-kind-icon">Ledger<wbr/>Stream</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_base" class="tsd-kind-icon">fee_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#fee_ref" class="tsd-kind-icon">fee_<wbr/>ref</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#ledger_time" class="tsd-kind-icon">ledger_<wbr/>time</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_base" class="tsd-kind-icon">reserve_<wbr/>base</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#reserve_inc" class="tsd-kind-icon">reserve_<wbr/>inc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#txn_count" class="tsd-kind-icon">txn_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerStream.html#validated_ledgers" class="tsd-kind-icon">validated_<wbr/>ledgers</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
Block a user