mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-06 17:27:59 +00:00
update reference docs and add readme to homepage (#2112)
This commit is contained in:
jonathanlei
@@ -25,7 +25,7 @@ XRP balance.</p>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><span class="target">AccountRoot</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L9">packages/xrpl/src/models/ledger/AccountRoot.ts:9</a></li></ul></aside>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L9">packages/xrpl/src/models/ledger/AccountRoot.ts:9</a></li></ul></aside>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
||||
@@ -34,21 +34,21 @@ XRP balance.</p>
|
||||
<section class="tsd-index-section">
|
||||
<h3 class="tsd-index-heading">Properties</h3>
|
||||
<div class="tsd-index-list"><a href="LedgerEntry.AccountRoot.html#Account" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>Account</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#AccountTxnID" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Account<wbr/>TxnID</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#AccountTxnID" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Account<wbr/>TxnID?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#Balance" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Balance</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#Domain" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Domain</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#EmailHash" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Email<wbr/>Hash</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#Domain" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Domain?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#EmailHash" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Email<wbr/>Hash?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#Flags" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Flags</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#LedgerEntryType" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Ledger<wbr/>Entry<wbr/>Type</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#MessageKey" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Message<wbr/>Key</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#MessageKey" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Message<wbr/>Key?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#OwnerCount" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Owner<wbr/>Count</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#PreviousTxnID" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Previous<wbr/>TxnID</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#PreviousTxnLgrSeq" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#RegularKey" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Regular<wbr/>Key</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#RegularKey" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Regular<wbr/>Key?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#Sequence" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Sequence</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#TickSize" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Tick<wbr/>Size</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#TicketCount" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Ticket<wbr/>Count</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#TransferRate" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Transfer<wbr/>Rate</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#TickSize" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Tick<wbr/>Size?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#TicketCount" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Ticket<wbr/>Count?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#TransferRate" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Transfer<wbr/>Rate?</span></a>
|
||||
<a href="LedgerEntry.AccountRoot.html#index" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>index</span></a>
|
||||
</div></section></div></details></section></section>
|
||||
<section class="tsd-panel-group tsd-member-group">
|
||||
@@ -59,7 +59,7 @@ XRP balance.</p>
|
||||
<div class="tsd-comment tsd-typography"><p>The identifying (classic) address of this account.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L12">packages/xrpl/src/models/ledger/AccountRoot.ts:12</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L12">packages/xrpl/src/models/ledger/AccountRoot.ts:12</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="AccountTxnID" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Account<wbr/>TxnID</span><a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
||||
@@ -69,14 +69,14 @@ field. To enable it, send an AccountSet transaction with the.
|
||||
<code>asfAccountTxnID</code> flag enabled.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L40">packages/xrpl/src/models/ledger/AccountRoot.ts:40</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L40">packages/xrpl/src/models/ledger/AccountRoot.ts:40</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Balance" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>Balance</span><a href="#Balance" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Balance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<div class="tsd-comment tsd-typography"><p>The account's current XRP balance in drops, represented as a string.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L14">packages/xrpl/src/models/ledger/AccountRoot.ts:14</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L14">packages/xrpl/src/models/ledger/AccountRoot.ts:14</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Domain" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Domain</span><a href="#Domain" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Domain<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
||||
@@ -84,26 +84,26 @@ field. To enable it, send an AccountSet transaction with the.
|
||||
for the ASCII representation of the domain.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L45">packages/xrpl/src/models/ledger/AccountRoot.ts:45</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L45">packages/xrpl/src/models/ledger/AccountRoot.ts:45</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="EmailHash" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Email<wbr/>Hash</span><a href="#EmailHash" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Email<wbr/>Hash<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<div class="tsd-comment tsd-typography"><p>The md5 hash of an email address.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L47">packages/xrpl/src/models/ledger/AccountRoot.ts:47</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L47">packages/xrpl/src/models/ledger/AccountRoot.ts:47</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Flags" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>Flags</span><a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<div class="tsd-comment tsd-typography"><p>A bit-map of boolean flags enabled for this account.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L16">packages/xrpl/src/models/ledger/AccountRoot.ts:16</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L16">packages/xrpl/src/models/ledger/AccountRoot.ts:16</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LedgerEntryType" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>Ledger<wbr/>Entry<wbr/>Type</span><a href="#LedgerEntryType" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Ledger<wbr/>Entry<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"AccountRoot"</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L10">packages/xrpl/src/models/ledger/AccountRoot.ts:10</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L10">packages/xrpl/src/models/ledger/AccountRoot.ts:10</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="MessageKey" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Message<wbr/>Key</span><a href="#MessageKey" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Message<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
||||
@@ -111,7 +111,7 @@ for the ASCII representation of the domain.</p>
|
||||
in JSON, uses hexadecimal.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L52">packages/xrpl/src/models/ledger/AccountRoot.ts:52</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L52">packages/xrpl/src/models/ledger/AccountRoot.ts:52</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="OwnerCount" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>Owner<wbr/>Count</span><a href="#OwnerCount" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Owner<wbr/>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
@@ -119,7 +119,7 @@ in JSON, uses hexadecimal.</p>
|
||||
to its owner reserve.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L21">packages/xrpl/src/models/ledger/AccountRoot.ts:21</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L21">packages/xrpl/src/models/ledger/AccountRoot.ts:21</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PreviousTxnID" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>Previous<wbr/>TxnID</span><a href="#PreviousTxnID" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Previous<wbr/>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
@@ -127,7 +127,7 @@ to its owner reserve.</p>
|
||||
object.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L26">packages/xrpl/src/models/ledger/AccountRoot.ts:26</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L26">packages/xrpl/src/models/ledger/AccountRoot.ts:26</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PreviousTxnLgrSeq" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</span><a href="#PreviousTxnLgrSeq" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
@@ -135,7 +135,7 @@ object.</p>
|
||||
modified this object.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L31">packages/xrpl/src/models/ledger/AccountRoot.ts:31</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L31">packages/xrpl/src/models/ledger/AccountRoot.ts:31</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="RegularKey" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Regular<wbr/>Key</span><a href="#RegularKey" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Regular<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
||||
@@ -144,14 +144,14 @@ account instead of the master key. Use a SetRegularKey transaction to
|
||||
change this value.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L58">packages/xrpl/src/models/ledger/AccountRoot.ts:58</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L58">packages/xrpl/src/models/ledger/AccountRoot.ts:58</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Sequence" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>Sequence</span><a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<div class="tsd-comment tsd-typography"><p>The sequence number of the next valid transaction for this account.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L33">packages/xrpl/src/models/ledger/AccountRoot.ts:33</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L33">packages/xrpl/src/models/ledger/AccountRoot.ts:33</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="TickSize" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Tick<wbr/>Size</span><a href="#TickSize" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Tick<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
||||
@@ -159,7 +159,7 @@ change this value.</p>
|
||||
currencies issued by this address. Valid values are 3 to 15, inclusive.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L69">packages/xrpl/src/models/ledger/AccountRoot.ts:69</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L69">packages/xrpl/src/models/ledger/AccountRoot.ts:69</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="TicketCount" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Ticket<wbr/>Count</span><a href="#TicketCount" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Ticket<wbr/>Count<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
||||
@@ -168,7 +168,7 @@ automatically to ensure that the account stays within the hard limit of 250.
|
||||
Tickets at a time.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L64">packages/xrpl/src/models/ledger/AccountRoot.ts:64</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L64">packages/xrpl/src/models/ledger/AccountRoot.ts:64</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="TransferRate" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Transfer<wbr/>Rate</span><a href="#TransferRate" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">Transfer<wbr/>Rate<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
||||
@@ -176,13 +176,13 @@ Tickets at a time.</p>
|
||||
account to each other.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/AccountRoot.ts#L74">packages/xrpl/src/models/ledger/AccountRoot.ts:74</a></li></ul></aside></section>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L74">packages/xrpl/src/models/ledger/AccountRoot.ts:74</a></li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="index" class="tsd-anchor"></a>
|
||||
<h3 class="tsd-anchor-link"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||||
<div class="tsd-signature">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/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></section></section></div>
|
||||
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></section></section></div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<div class="tsd-navigation settings">
|
||||
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
||||
@@ -210,21 +210,21 @@ account to each other.</p>
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="LedgerEntry.AccountRoot.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Account<wbr/>Root</span></a>
|
||||
<ul>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#Account" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Account</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#AccountTxnID" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Account<wbr/>TxnID</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#AccountTxnID" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Account<wbr/>TxnID?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#Balance" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Balance</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#Domain" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Domain</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#EmailHash" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Email<wbr/>Hash</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#Domain" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Domain?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#EmailHash" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Email<wbr/>Hash?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#Flags" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Flags</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#LedgerEntryType" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Ledger<wbr/>Entry<wbr/>Type</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#MessageKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Message<wbr/>Key</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#MessageKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Message<wbr/>Key?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#OwnerCount" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Owner<wbr/>Count</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#PreviousTxnID" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Previous<wbr/>TxnID</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#PreviousTxnLgrSeq" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#RegularKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Regular<wbr/>Key</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#RegularKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Regular<wbr/>Key?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#Sequence" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Sequence</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#TickSize" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Tick<wbr/>Size</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#TicketCount" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Ticket<wbr/>Count</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#TransferRate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Transfer<wbr/>Rate</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#TickSize" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Tick<wbr/>Size?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#TicketCount" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Ticket<wbr/>Count?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.AccountRoot.html#TransferRate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Transfer<wbr/>Rate?</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntry.AccountRoot.html#index" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>index</a></li></ul></li></ul></nav></div></div>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
||||
|
||||
Reference in New Issue
Block a user