mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-29 08:35:49 +00:00
correctly document stuff (#1878)
This commit is contained in:
ledhed2222
@@ -3,43 +3,43 @@
|
||||
in its raw format. Expects a response in the form of a <a href="LedgerEntryResponse.html">LedgerEntryResponse</a>.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ledgerEntry</span><span class="hl-1">: </span><span class="hl-9">LedgerEntryRequest</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-4">command:</span><span class="hl-1"> </span><span class="hl-7">"ledger_entry"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">ledger_index:</span><span class="hl-1"> </span><span class="hl-8">60102302</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">index:</span><span class="hl-1"> </span><span class="hl-7">"7DB0788C020F02780A673DC74757F23823FA3014C1866E72CC4CD8B226CD6EF4"</span><br/><span class="hl-1">}</span>
|
||||
</code></pre>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">LedgerEntryRequest</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="LedgerEntryRequest.html#account_root" class="tsd-kind-icon">account_<wbr/>root</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#check" class="tsd-kind-icon">check</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerEntryRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#deposit_preauth" class="tsd-kind-icon">deposit_<wbr/>preauth</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#directory" class="tsd-kind-icon">directory</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#escrow" class="tsd-kind-icon">escrow</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#offer" class="tsd-kind-icon">offer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#payment_channel" class="tsd-kind-icon">payment_<wbr/>channel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ripple_state" class="tsd-kind-icon">ripple_<wbr/>state</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ticket" class="tsd-kind-icon">ticket</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="account_root" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> account_<wbr/>root</h3><div class="tsd-signature tsd-kind-icon">account_<wbr/>root<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/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L47">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseRequest</span><ul class="tsd-hierarchy"><li><span class="target">LedgerEntryRequest</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="LedgerEntryRequest.html#account_root" class="tsd-kind-icon">account_<wbr/>root</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryRequest.html#api_version" class="tsd-kind-icon">api_<wbr/>version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#binary" class="tsd-kind-icon">binary</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#check" class="tsd-kind-icon">check</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="LedgerEntryRequest.html#command" class="tsd-kind-icon">command</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#deposit_preauth" class="tsd-kind-icon">deposit_<wbr/>preauth</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#directory" class="tsd-kind-icon">directory</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#escrow" class="tsd-kind-icon">escrow</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntryRequest.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ledger_hash" class="tsd-kind-icon">ledger_<wbr/>hash</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ledger_index" class="tsd-kind-icon">ledger_<wbr/>index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#offer" class="tsd-kind-icon">offer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#payment_channel" class="tsd-kind-icon">payment_<wbr/>channel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ripple_state" class="tsd-kind-icon">ripple_<wbr/>state</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntryRequest.html#ticket" class="tsd-kind-icon">ticket</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="account_root" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> account_<wbr/>root</h3><div class="tsd-signature tsd-kind-icon">account_<wbr/>root<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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L47">packages/xrpl/src/models/methods/ledgerEntry.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Retrieve an AccountRoot object by its address. This is roughly equivalent
|
||||
to the an <a href="AccountInfoRequest.html">AccountInfoRequest</a>.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L14">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="api_version" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> api_<wbr/>version</h3><div class="tsd-signature tsd-kind-icon">api_<wbr/>version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.api_version</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/baseMethod.ts#L14">packages/xrpl/src/models/methods/baseMethod.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The API version to use. If omitted, use version 1.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="binary" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> binary</h3><div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L29">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="binary" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> binary</h3><div class="tsd-signature tsd-kind-icon">binary<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L29">packages/xrpl/src/models/methods/ledgerEntry.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>If true, return the requested ledger object's contents as a hex string in
|
||||
the XRP Ledger's binary format. Otherwise, return data in JSON format. The
|
||||
default is false.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="check" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> check</h3><div class="tsd-signature tsd-kind-icon">check<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/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L95">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="check" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> check</h3><div class="tsd-signature tsd-kind-icon">check<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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L95">packages/xrpl/src/models/methods/ledgerEntry.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The object ID of a Check object to retrieve.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ledger_entry"</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L23">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="deposit_preauth" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> deposit_<wbr/>preauth</h3><div class="tsd-signature tsd-kind-icon">deposit_<wbr/>preauth<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>authorized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L118">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="command" class="tsd-anchor"></a><h3>command</h3><div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ledger_entry"</span></div><aside class="tsd-sources"><p>Overrides BaseRequest.command</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L23">packages/xrpl/src/models/methods/ledgerEntry.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="deposit_preauth" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> deposit_<wbr/>preauth</h3><div class="tsd-signature tsd-kind-icon">deposit_<wbr/>preauth<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>authorized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L118">packages/xrpl/src/models/methods/ledgerEntry.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Specify a DepositPreauth object to retrieve. If a string, must be the
|
||||
object ID of the DepositPreauth object, as hexadecimal. If an object,
|
||||
requires owner and authorized sub-fields.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="directory" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> directory</h3><div class="tsd-signature tsd-kind-icon">directory<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>dir_root<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sub_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L54">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="directory" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> directory</h3><div class="tsd-signature tsd-kind-icon">directory<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>dir_root<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>sub_index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L54">packages/xrpl/src/models/methods/ledgerEntry.ts:54</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The DirectoryNode to retrieve. If a string, must be the object ID of the
|
||||
directory, as hexadecimal. If an object, requires either <code>dir_root</code> o
|
||||
Owner as a sub-field, plus optionally a <code>sub_index</code> sub-field.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="escrow" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> escrow</h3><div class="tsd-signature tsd-kind-icon">escrow<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L101">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="escrow" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> escrow</h3><div class="tsd-signature tsd-kind-icon">escrow<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L101">packages/xrpl/src/models/methods/ledgerEntry.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The Escrow object to retrieve. If a string, must be the object ID of the
|
||||
escrow, as hexadecimal. If an object, requires owner and seq sub-fields.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/baseMethod.ts#L10">ripple-lib/packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseRequest.id</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/baseMethod.ts#L10">packages/xrpl/src/models/methods/baseMethod.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A unique value to identify this request. The response to this request uses
|
||||
the same id field. This way, even if responses arrive out of order, you
|
||||
know which request prompted which response.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L41">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L31">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L41">packages/xrpl/src/models/methods/ledgerEntry.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_hash" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L31">packages/xrpl/src/models/methods/ledgerEntry.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>A 20-byte hex string for the ledger version to use.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ledger_index" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> 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">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L33">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</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><span class="tsd-flag ts-flagOptional">Optional</span> 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">LedgerIndex</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L33">packages/xrpl/src/models/methods/ledgerEntry.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The ledger index of the ledger to use, or a shortcut string.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="offer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> offer</h3><div class="tsd-signature tsd-kind-icon">offer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L70">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="offer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> offer</h3><div class="tsd-signature tsd-kind-icon">offer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L70">packages/xrpl/src/models/methods/ledgerEntry.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The Offer object to retrieve. If a string, interpret as the unique object
|
||||
ID to the Offer. If an object, requires the sub-fields <code>account</code> and <code>seq</code>
|
||||
to uniquely identify the offer.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="payment_channel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> payment_<wbr/>channel</h3><div class="tsd-signature tsd-kind-icon">payment_<wbr/>channel<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/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L111">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="payment_channel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> payment_<wbr/>channel</h3><div class="tsd-signature tsd-kind-icon">payment_<wbr/>channel<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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L111">packages/xrpl/src/models/methods/ledgerEntry.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The object ID of a PayChannel object to retrieve.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ripple_state" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ripple_<wbr/>state</h3><div class="tsd-signature tsd-kind-icon">ripple_<wbr/>state<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L84">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ripple_state" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ripple_<wbr/>state</h3><div class="tsd-signature tsd-kind-icon">ripple_<wbr/>state<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>accounts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L84">packages/xrpl/src/models/methods/ledgerEntry.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Object specifying the RippleState (trust line) object to retrieve. The
|
||||
accounts and currency sub-fields are required to uniquely specify the
|
||||
rippleState entry to retrieve.</p>
|
||||
@@ -48,7 +48,7 @@ rippleState entry to retrieve.</p>
|
||||
this RippleState object.</p>
|
||||
</div></div></li><li class="tsd-parameter"><h5>currency<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Currency Code of the RippleState object to retrieve.</p>
|
||||
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ticket" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ticket</h3><div class="tsd-signature tsd-kind-icon">ticket<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ticket_sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/fcf448da/packages/xrpl/src/models/methods/ledgerEntry.ts#L132">ripple-lib/packages/xrpl/src/models/methods/ledgerEntry.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ticket" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ticket</h3><div class="tsd-signature tsd-kind-icon">ticket<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ticket_sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/46a8adca/packages/xrpl/src/models/methods/ledgerEntry.ts#L132">packages/xrpl/src/models/methods/ledgerEntry.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The Ticket object to retrieve. If a string, must be the object ID of the
|
||||
Ticket, as hexadecimal. If an object, the <code>owner</code> and <code>ticket_sequence</code>
|
||||
sub-fields are required to uniquely specify the Ticket entry.</p>
|
||||
|
||||
Reference in New Issue
Block a user