ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-01 09:35:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2.0.1
xahau.js/docs/interfaces/LedgerEntry.RippleState.html
Jackson Mills e813ec4bd3 bug: Fix private interfaces not showing up in the docs (#1769) 
Make all exported function parameters and return types show their shapes so that new developers can see how to use them in the docs.
2021-10-29 13:13:40 -07:00

43 lines
20 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>RippleState | 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="../modules/LedgerEntry.html">LedgerEntry</a></li><li><a href="LedgerEntry.RippleState.html">RippleState</a></li></ul><h1>Interface RippleState</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 RippleState object type connects two accounts in a single currency.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseLedgerEntry</span><ul class="tsd-hierarchy"><li><span class="target">RippleState</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="LedgerEntry.RippleState.html#Balance" class="tsd-kind-icon">Balance</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighLimit" class="tsd-kind-icon">High<wbr/>Limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighNode" class="tsd-kind-icon">High<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighQualityIn" class="tsd-kind-icon">High<wbr/>Quality<wbr/>In</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighQualityOut" class="tsd-kind-icon">High<wbr/>Quality<wbr/>Out</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowLimit" class="tsd-kind-icon">Low<wbr/>Limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowNode" class="tsd-kind-icon">Low<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowQualityIn" class="tsd-kind-icon">Low<wbr/>Quality<wbr/>In</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowQualityOut" class="tsd-kind-icon">Low<wbr/>Quality<wbr/>Out</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#PreviousTxnID" class="tsd-kind-icon">Previous<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#PreviousTxnLgrSeq" class="tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntry.RippleState.html#index" class="tsd-kind-icon">index</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="Balance" class="tsd-anchor"></a><h3>Balance</h3><div class="tsd-signature tsd-kind-icon">Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IssuedCurrencyAmount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L19">src/models/ledger/RippleState.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The balance of the trust line, from the perspective of the low account. A
negative balance indicates that the low account has issued currency to the
high account. The issuer is always the neutral value ACCOUNT_ONE.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Flags" class="tsd-anchor"></a><h3>Flags</h3><div class="tsd-signature tsd-kind-icon">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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L13">src/models/ledger/RippleState.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A bit-map of boolean options enabled for this object.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="HighLimit" class="tsd-anchor"></a><h3>High<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">High<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IssuedCurrencyAmount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L29">src/models/ledger/RippleState.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit that the high account has set on the trust line. The issuer is
the address of the high account that set this limit.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="HighNode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> High<wbr/>Node</h3><div class="tsd-signature tsd-kind-icon">High<wbr/>Node<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L49">src/models/ledger/RippleState.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A hint indicating which page of the high account&#39;s owner directory links
to this object, in case the directory consists of multiple pages.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="HighQualityIn" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> High<wbr/>Quality<wbr/>In</h3><div class="tsd-signature tsd-kind-icon">High<wbr/>Quality<wbr/>In<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L67">src/models/ledger/RippleState.ts:67</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The inbound quality set by the high account, as an integer in the implied
ratio HighQualityIn:1,000,000,000. As a special case, the value 0 is
equivalent to 1 billion, or face value.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="HighQualityOut" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> High<wbr/>Quality<wbr/>Out</h3><div class="tsd-signature tsd-kind-icon">High<wbr/>Quality<wbr/>Out<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L73">src/models/ledger/RippleState.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The outbound quality set by the high account, as an integer in the implied
ratio HighQualityOut:1,000,000,000. As a special case, the value 0 is
equivalent to 1 billion, or face value.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="LedgerEntryType" class="tsd-anchor"></a><h3>Ledger<wbr/>Entry<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;RippleState&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L11">src/models/ledger/RippleState.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="LowLimit" class="tsd-anchor"></a><h3>Low<wbr/>Limit</h3><div class="tsd-signature tsd-kind-icon">Low<wbr/>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IssuedCurrencyAmount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L24">src/models/ledger/RippleState.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit that the low account has set on the trust line. The issuer is
the address of the low account that set this limit.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="LowNode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Low<wbr/>Node</h3><div class="tsd-signature tsd-kind-icon">Low<wbr/>Node<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L44">src/models/ledger/RippleState.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A hint indicating which page of the low account&#39;s owner directory links to
this object, in case the directory consists of multiple pages.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="LowQualityIn" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Low<wbr/>Quality<wbr/>In</h3><div class="tsd-signature tsd-kind-icon">Low<wbr/>Quality<wbr/>In<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L55">src/models/ledger/RippleState.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The inbound quality set by the low account, as an integer in the implied
ratio LowQualityIn:1,000,000,000. As a special case, the value 0 is
equivalent to 1 billion, or face value.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="LowQualityOut" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Low<wbr/>Quality<wbr/>Out</h3><div class="tsd-signature tsd-kind-icon">Low<wbr/>Quality<wbr/>Out<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L61">src/models/ledger/RippleState.ts:61</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The outbound quality set by the low account, as an integer in the implied
ratio LowQualityOut:1,000,000,000. As a special case, the value 0 is
equivalent to 1 billion, or face value.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="PreviousTxnID" class="tsd-anchor"></a><h3>Previous<wbr/>TxnID</h3><div class="tsd-signature tsd-kind-icon">Previous<wbr/>TxnID<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L34">src/models/ledger/RippleState.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The identifying hash of the transaction that most recently modified this
object.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="PreviousTxnLgrSeq" class="tsd-anchor"></a><h3>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</h3><div class="tsd-signature tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq<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/ripple/ripple-lib/blob/34f172cc/src/models/ledger/RippleState.ts#L39">src/models/ledger/RippleState.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The index of the ledger that contains the transaction that most recently
modified this object.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="index" class="tsd-anchor"></a><h3>index</h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseLedgerEntry.index</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/34f172cc/src/models/ledger/BaseLedgerEntry.ts#L2">src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></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.RippleState.html" class="tsd-kind-icon">Ripple<wbr/>State</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#Balance" class="tsd-kind-icon">Balance</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighLimit" class="tsd-kind-icon">High<wbr/>Limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighNode" class="tsd-kind-icon">High<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighQualityIn" class="tsd-kind-icon">High<wbr/>Quality<wbr/>In</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#HighQualityOut" class="tsd-kind-icon">High<wbr/>Quality<wbr/>Out</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowLimit" class="tsd-kind-icon">Low<wbr/>Limit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowNode" class="tsd-kind-icon">Low<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowQualityIn" class="tsd-kind-icon">Low<wbr/>Quality<wbr/>In</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#LowQualityOut" class="tsd-kind-icon">Low<wbr/>Quality<wbr/>Out</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#PreviousTxnID" class="tsd-kind-icon">Previous<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.RippleState.html#PreviousTxnLgrSeq" class="tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntry.RippleState.html#index" class="tsd-kind-icon">index</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