mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 12:15:51 +00:00
8 lines
15 KiB
HTML
8 lines
15 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LedgerEntry | 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="LedgerEntry.html">LedgerEntry</a></li></ul><h1>Namespace LedgerEntry </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>LedgerEntry type definitions are exported in their own namespace to prevent
|
|
collisions of the DepositPreauth SLE and Transaction. LedgerEntries are used
|
|
by the client less often, and in most scenarios, like when parsing a
|
|
response, the client won't need to import the type. If it is required to use
|
|
a Ledger Entry, import <code>LedgerEntry</code>, and access individual ledger entry
|
|
types on the <code>LedgerEntry</code> namespace.</p>
|
|
</div></div></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>Ledger Entries</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.AccountRoot.html" class="tsd-kind-icon">Account<wbr/>Root</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Amendments.html" class="tsd-kind-icon">Amendments</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Check.html" class="tsd-kind-icon">Check</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.DepositPreauth.html" class="tsd-kind-icon">Deposit<wbr/>Preauth</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.DirectoryNode.html" class="tsd-kind-icon">Directory<wbr/>Node</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Escrow.html" class="tsd-kind-icon">Escrow</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.FeeSettings.html" class="tsd-kind-icon">Fee<wbr/>Settings</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Ledger.html" class="tsd-kind-icon">Ledger</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.LedgerHashes.html" class="tsd-kind-icon">Ledger<wbr/>Hashes</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.NegativeUNL.html" class="tsd-kind-icon">NegativeUNL</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.PayChannel.html" class="tsd-kind-icon">Pay<wbr/>Channel</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.RippleState.html" class="tsd-kind-icon">Ripple<wbr/>State</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.SignerList.html" class="tsd-kind-icon">Signer<wbr/>List</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Ticket.html" class="tsd-kind-icon">Ticket</a></li></ul></section><section class="tsd-index-section"><h3>Other</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.AccountRootFlags.html" class="tsd-kind-icon">Account<wbr/>Root<wbr/>Flags</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.OfferFlags.html" class="tsd-kind-icon">Offer<wbr/>Flags</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.RippleStateFlags.html" class="tsd-kind-icon">Ripple<wbr/>State<wbr/>Flags</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.SignerListFlags.html" class="tsd-kind-icon">Signer<wbr/>List<wbr/>Flags</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.AccountRootFlagsInterface.html" class="tsd-kind-icon">Account<wbr/>Root<wbr/>Flags<wbr/>Interface</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Offer.html" class="tsd-kind-icon">Offer</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="LedgerEntry.html#LedgerEntry-1" class="tsd-kind-icon">Ledger<wbr/>Entry</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-kind-namespace"><h2>Other</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="LedgerEntry-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Ledger<wbr/>Entry<a href="#LedgerEntry-1" 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/>Entry<span class="tsd-signature-symbol">:</span> <a href="../interfaces/LedgerEntry.AccountRoot.html" class="tsd-signature-type" data-tsd-kind="Interface">AccountRoot</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Amendments.html" class="tsd-signature-type" data-tsd-kind="Interface">Amendments</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Check.html" class="tsd-signature-type" data-tsd-kind="Interface">Check</a><span class="tsd-signature-symbol"> | </span><a href="LedgerEntry.html" class="tsd-signature-type" data-tsd-kind="Namespace">LedgerEntry</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/LedgerEntry.DepositPreauth.html" class="tsd-signature-type" data-tsd-kind="Interface">DepositPreauth</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.DirectoryNode.html" class="tsd-signature-type" data-tsd-kind="Interface">DirectoryNode</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Escrow.html" class="tsd-signature-type" data-tsd-kind="Interface">Escrow</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.FeeSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeSettings</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.LedgerHashes.html" class="tsd-signature-type" data-tsd-kind="Interface">LedgerHashes</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.NegativeUNL.html" class="tsd-signature-type" data-tsd-kind="Interface">NegativeUNL</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Offer.html" class="tsd-signature-type" data-tsd-kind="Interface">Offer</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.PayChannel.html" class="tsd-signature-type" data-tsd-kind="Interface">PayChannel</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.RippleState.html" class="tsd-signature-type" data-tsd-kind="Interface">RippleState</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.SignerList.html" class="tsd-signature-type" data-tsd-kind="Interface">SignerList</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/LedgerEntry.Ticket.html" class="tsd-signature-type" data-tsd-kind="Interface">Ticket</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/LedgerEntry.ts#L16">packages/xrpl/src/models/ledger/LedgerEntry.ts:16</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="LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.AccountRootFlags.html" class="tsd-kind-icon">Account<wbr/>Root<wbr/>Flags</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.OfferFlags.html" class="tsd-kind-icon">Offer<wbr/>Flags</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.RippleStateFlags.html" class="tsd-kind-icon">Ripple<wbr/>State<wbr/>Flags</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/LedgerEntry.SignerListFlags.html" class="tsd-kind-icon">Signer<wbr/>List<wbr/>Flags</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.AccountRoot.html" class="tsd-kind-icon">Account<wbr/>Root</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.AccountRootFlagsInterface.html" class="tsd-kind-icon">Account<wbr/>Root<wbr/>Flags<wbr/>Interface</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Amendments.html" class="tsd-kind-icon">Amendments</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Check.html" class="tsd-kind-icon">Check</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.DepositPreauth.html" class="tsd-kind-icon">Deposit<wbr/>Preauth</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.DirectoryNode.html" class="tsd-kind-icon">Directory<wbr/>Node</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Escrow.html" class="tsd-kind-icon">Escrow</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.FeeSettings.html" class="tsd-kind-icon">Fee<wbr/>Settings</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Ledger.html" class="tsd-kind-icon">Ledger</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.LedgerHashes.html" class="tsd-kind-icon">Ledger<wbr/>Hashes</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.NegativeUNL.html" class="tsd-kind-icon">NegativeUNL</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Offer.html" class="tsd-kind-icon">Offer</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.PayChannel.html" class="tsd-kind-icon">Pay<wbr/>Channel</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.RippleState.html" class="tsd-kind-icon">Ripple<wbr/>State</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.SignerList.html" class="tsd-kind-icon">Signer<wbr/>List</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/LedgerEntry.Ticket.html" class="tsd-kind-icon">Ticket</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="LedgerEntry.html#LedgerEntry-1" class="tsd-kind-icon">Ledger<wbr/>Entry</a></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> |