ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

update reference docs and add readme to homepage (#2112)

Browse Source
This commit is contained in:
jonathanlei
2022-10-13 09:21:28 -07:00
committed by GitHub
parent 9df848fcc6
commit 1ceae703db
214 changed files with 3761 additions and 3651 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/enums/LedgerEntry.AccountRootFlags.html
View File

@@ -15,7 +15,7 @@
<li><a href="LedgerEntry.AccountRootFlags.html">AccountRootFlags</a></li></ul>
<h1>Enumeration AccountRootFlags</h1></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#L121">packages/xrpl/src/models/ledger/AccountRoot.ts:121</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/AccountRoot.ts#L121">packages/xrpl/src/models/ledger/AccountRoot.ts:121</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">
@@ -38,10 +38,10 @@
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDefaultRipple" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>Default<wbr/>Ripple</span><a href="#lsfDefaultRipple" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature">lsf<wbr/>Default<wbr/>Ripple<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">8388608</span></div>
<div class="tsd-comment tsd-typography"><p>Enable rippling on this addresses&#39;s trust lines by default. Required for issuing addresses; discouraged for others.</p>
<div class="tsd-comment tsd-typography"><p>Enable rippling on this address&#39;s trust lines by default. Required for issuing addresses; discouraged for others.</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#L153">packages/xrpl/src/models/ledger/AccountRoot.ts:153</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#L153">packages/xrpl/src/models/ledger/AccountRoot.ts:153</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDepositAuth" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>Deposit<wbr/>Auth</span><a href="#lsfDepositAuth" 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">lsf<wbr/>Deposit<wbr/>Auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">16777216</span></div>
@@ -49,56 +49,56 @@
(It has DepositAuth 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#L158">packages/xrpl/src/models/ledger/AccountRoot.ts:158</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#L158">packages/xrpl/src/models/ledger/AccountRoot.ts:158</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDisableMaster" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>Disable<wbr/>Master</span><a href="#lsfDisableMaster" 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">lsf<wbr/>Disable<wbr/>Master<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1048576</span></div>
<div class="tsd-comment tsd-typography"><p>Disallows use of the master key to sign transactions 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#L141">packages/xrpl/src/models/ledger/AccountRoot.ts:141</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#L141">packages/xrpl/src/models/ledger/AccountRoot.ts:141</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfDisallowXRP" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>DisallowXRP</span><a href="#lsfDisallowXRP" 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">lsf<wbr/>DisallowXRP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">524288</span></div>
<div class="tsd-comment tsd-typography"><p>Client applications should not send XRP to this account. Not enforced by rippled.</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#L137">packages/xrpl/src/models/ledger/AccountRoot.ts:137</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#L137">packages/xrpl/src/models/ledger/AccountRoot.ts:137</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfGlobalFreeze" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>Global<wbr/>Freeze</span><a href="#lsfGlobalFreeze" 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">lsf<wbr/>Global<wbr/>Freeze<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4194304</span></div>
<div class="tsd-comment tsd-typography"><p>All assets issued by this address are frozen.</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#L149">packages/xrpl/src/models/ledger/AccountRoot.ts:149</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#L149">packages/xrpl/src/models/ledger/AccountRoot.ts:149</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfNoFreeze" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>No<wbr/>Freeze</span><a href="#lsfNoFreeze" 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">lsf<wbr/>No<wbr/>Freeze<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2097152</span></div>
<div class="tsd-comment tsd-typography"><p>This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.</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#L145">packages/xrpl/src/models/ledger/AccountRoot.ts:145</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#L145">packages/xrpl/src/models/ledger/AccountRoot.ts:145</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfPasswordSpent" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>Password<wbr/>Spent</span><a href="#lsfPasswordSpent" 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">lsf<wbr/>Password<wbr/>Spent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">65536</span></div>
<div class="tsd-comment tsd-typography"><p>The account has used its free SetRegularKey transaction.</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#L125">packages/xrpl/src/models/ledger/AccountRoot.ts:125</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#L125">packages/xrpl/src/models/ledger/AccountRoot.ts:125</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfRequireAuth" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>Require<wbr/>Auth</span><a href="#lsfRequireAuth" 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">lsf<wbr/>Require<wbr/>Auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">262144</span></div>
<div class="tsd-comment tsd-typography"><p>This account must individually approve other users for those users to hold this account&#39;s issued currencies.</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#L133">packages/xrpl/src/models/ledger/AccountRoot.ts:133</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#L133">packages/xrpl/src/models/ledger/AccountRoot.ts:133</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="lsfRequireDestTag" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>lsf<wbr/>Require<wbr/>Dest<wbr/>Tag</span><a href="#lsfRequireDestTag" 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">lsf<wbr/>Require<wbr/>Dest<wbr/>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">131072</span></div>
<div class="tsd-comment tsd-typography"><p>Requires incoming payments to specify a Destination Tag.</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#L129">packages/xrpl/src/models/ledger/AccountRoot.ts:129</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/AccountRoot.ts#L129">packages/xrpl/src/models/ledger/AccountRoot.ts:129</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">