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

20
docs/interfaces/LedgerEntry.SignerList.html
View File

@@ -27,7 +27,7 @@ transaction.</p>
<ul class="tsd-hierarchy">
<li><span class="target">SignerList</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/SignerList.ts#L18">packages/xrpl/src/models/ledger/SignerList.ts:18</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L18">packages/xrpl/src/models/ledger/SignerList.ts:18</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">
@@ -54,12 +54,12 @@ transaction.</p>
information, see SignerList Flags.</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/SignerList.ts#L24">packages/xrpl/src/models/ledger/SignerList.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L24">packages/xrpl/src/models/ledger/SignerList.ts:24</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">&quot;SignerList&quot;</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/SignerList.ts#L19">packages/xrpl/src/models/ledger/SignerList.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L19">packages/xrpl/src/models/ledger/SignerList.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="OwnerNode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Owner<wbr/>Node</span><a href="#OwnerNode" 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/>Node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -67,7 +67,7 @@ information, see SignerList Flags.</p>
in case the directory consists of multiple pages.</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/SignerList.ts#L39">packages/xrpl/src/models/ledger/SignerList.ts:39</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L39">packages/xrpl/src/models/ledger/SignerList.ts:39</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>
@@ -75,7 +75,7 @@ in case the directory consists of multiple pages.</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/SignerList.ts#L29">packages/xrpl/src/models/ledger/SignerList.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L29">packages/xrpl/src/models/ledger/SignerList.ts:29</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>
@@ -83,7 +83,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/SignerList.ts#L34">packages/xrpl/src/models/ledger/SignerList.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L34">packages/xrpl/src/models/ledger/SignerList.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SignerEntries" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Signer<wbr/>Entries</span><a href="#SignerEntries" 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">Signer<wbr/>Entries<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SignerEntry</span><span class="tsd-signature-symbol">[]</span></div>
@@ -91,7 +91,7 @@ modified this object.</p>
this signer list.</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/SignerList.ts#L44">packages/xrpl/src/models/ledger/SignerList.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L44">packages/xrpl/src/models/ledger/SignerList.ts:44</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SignerListID" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Signer<wbr/>ListID</span><a href="#SignerListID" 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">Signer<wbr/>ListID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -99,7 +99,7 @@ this signer list.</p>
amendment allows multiple signer lists for an account, this may change.</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/SignerList.ts#L49">packages/xrpl/src/models/ledger/SignerList.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L49">packages/xrpl/src/models/ledger/SignerList.ts:49</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SignerQuorum" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Signer<wbr/>Quorum</span><a href="#SignerQuorum" 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">Signer<wbr/>Quorum<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -108,13 +108,13 @@ owner of this SignerList, the signers must provide valid signatures whose
weights sum to this value or more.</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/SignerList.ts#L55">packages/xrpl/src/models/ledger/SignerList.ts:55</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/SignerList.ts#L55">packages/xrpl/src/models/ledger/SignerList.ts:55</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">