mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-29 16:45:49 +00:00
refactor: rename hash functions (#1701)
- Rename hash functions to be shorter for easier use. - Namespace hash functions into xrpl.hashes
This commit is contained in:
Omar Khan
@@ -187,19 +187,19 @@
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function"><a href="modules.html#ISOTimeToRippleTime" class="tsd-kind-icon">ISOTime<wbr>ToRipple<wbr>Time</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeAccountRootIndex" class="tsd-kind-icon">compute<wbr>Account<wbr>Root<wbr>Index</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashAccountRoot" class="tsd-kind-icon">compute<wbr>Account<wbr>Root<wbr>Index</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeBinaryTransactionHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeBinaryTransactionSigningHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeEscrowHash" class="tsd-kind-icon">compute<wbr>Escrow<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeLedgerHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeLedgerHeaderHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeOfferIndex" class="tsd-kind-icon">compute<wbr>Offer<wbr>Index</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computePaymentChannelHash" class="tsd-kind-icon">compute<wbr>Payment<wbr>Channel<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeSignerListIndex" class="tsd-kind-icon">compute<wbr>Signer<wbr>List<wbr>Index</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeStateTreeHash" class="tsd-kind-icon">compute<wbr>State<wbr>Tree<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashTx" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashEscrow" class="tsd-kind-icon">compute<wbr>Escrow<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashLedger" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashLedgerHeader" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashOfferId" class="tsd-kind-icon">compute<wbr>Offer<wbr>Index</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashPaymentChannel" class="tsd-kind-icon">compute<wbr>Payment<wbr>Channel<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashSignerListId" class="tsd-kind-icon">compute<wbr>Signer<wbr>List<wbr>Index</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashStateTree" class="tsd-kind-icon">compute<wbr>State<wbr>Tree<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeTransactionHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeTransactionTreeHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Tree<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#computeTrustlineHash" class="tsd-kind-icon">compute<wbr>Trustline<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashTxTree" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Tree<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#hashTrustline" class="tsd-kind-icon">compute<wbr>Trustline<wbr>Hash</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#convertKeysFromSnakeCaseToCamelCase" class="tsd-kind-icon">convert<wbr>Keys<wbr>From<wbr>Snake<wbr>Case<wbr>ToCamel<wbr>Case</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#dropsToXrp" class="tsd-kind-icon">drops<wbr>ToXrp</a></li>
|
||||
<li class="tsd-kind-function"><a href="modules.html#generateXAddress" class="tsd-kind-icon">generateXAddress</a></li>
|
||||
@@ -382,7 +382,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeAccountRootIndex" class="tsd-anchor"></a>
|
||||
<a name="hashAccountRoot" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Account<wbr>Root<wbr>Index</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Account<wbr>Root<wbr>Index<span class="tsd-signature-symbol">(</span>address<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><span class="tsd-signature-type">string</span></li>
|
||||
@@ -442,7 +442,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeBinaryTransactionSigningHash" class="tsd-anchor"></a>
|
||||
<a name="hashTx" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash<span class="tsd-signature-symbol">(</span>txBlobHex<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><span class="tsd-signature-type">string</span></li>
|
||||
@@ -475,7 +475,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeEscrowHash" class="tsd-anchor"></a>
|
||||
<a name="hashEscrow" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Escrow<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Escrow<wbr>Hash<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
@@ -501,7 +501,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeLedgerHash" class="tsd-anchor"></a>
|
||||
<a name="hashLedger" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Ledger<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Ledger<wbr>Hash<span class="tsd-signature-symbol">(</span>ledgerHeader<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
@@ -524,10 +524,10 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeLedgerHeaderHash" class="tsd-anchor"></a>
|
||||
<a name="hashLedgerHeader" class="tsd-anchor"></a>
|
||||
<h3>compute<wbr>Ledger<wbr>Header<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash<span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ComputeLedgerHeaderHashOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash<span class="tsd-signature-symbol">(</span>ledger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">hashLedgerHeaderOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
@@ -542,7 +542,7 @@
|
||||
<h5>ledger: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-type">ComputeLedgerHeaderHashOptions</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
<h5>options: <span class="tsd-signature-type">hashLedgerHeaderOptions</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
@@ -550,7 +550,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeOfferIndex" class="tsd-anchor"></a>
|
||||
<a name="hashOfferId" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Offer<wbr>Index</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Offer<wbr>Index<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
@@ -592,7 +592,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computePaymentChannelHash" class="tsd-anchor"></a>
|
||||
<a name="hashPaymentChannel" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Payment<wbr>Channel<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Payment<wbr>Channel<wbr>Hash<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dstAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
@@ -621,7 +621,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeSignerListIndex" class="tsd-anchor"></a>
|
||||
<a name="hashSignerListId" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Signer<wbr>List<wbr>Index</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Signer<wbr>List<wbr>Index<span class="tsd-signature-symbol">(</span>address<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><span class="tsd-signature-type">string</span></li>
|
||||
@@ -660,7 +660,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeStateTreeHash" class="tsd-anchor"></a>
|
||||
<a name="hashStateTree" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>State<wbr>Tree<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>State<wbr>Tree<wbr>Hash<span class="tsd-signature-symbol">(</span>entries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
@@ -706,7 +706,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeTransactionTreeHash" class="tsd-anchor"></a>
|
||||
<a name="hashTxTree" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Transaction<wbr>Tree<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Transaction<wbr>Tree<wbr>Hash<span class="tsd-signature-symbol">(</span>transactions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
@@ -729,7 +729,7 @@
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function">
|
||||
<a name="computeTrustlineHash" class="tsd-anchor"></a>
|
||||
<a name="hashTrustline" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> compute<wbr>Trustline<wbr>Hash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function">
|
||||
<li class="tsd-signature tsd-kind-icon">compute<wbr>Trustline<wbr>Hash<span class="tsd-signature-symbol">(</span>address1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, currency<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><span class="tsd-signature-type">string</span></li>
|
||||
@@ -1319,43 +1319,43 @@
|
||||
<a href="modules.html#ISOTimeToRippleTime" class="tsd-kind-icon">ISOTime<wbr>ToRipple<wbr>Time</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeAccountRootIndex" class="tsd-kind-icon">compute<wbr>Account<wbr>Root<wbr>Index</a>
|
||||
<a href="modules.html#hashAccountRoot" class="tsd-kind-icon">compute<wbr>Account<wbr>Root<wbr>Index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeBinaryTransactionHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeBinaryTransactionSigningHash" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash</a>
|
||||
<a href="modules.html#hashTx" class="tsd-kind-icon">compute<wbr>Binary<wbr>Transaction<wbr>Signing<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeEscrowHash" class="tsd-kind-icon">compute<wbr>Escrow<wbr>Hash</a>
|
||||
<a href="modules.html#hashEscrow" class="tsd-kind-icon">compute<wbr>Escrow<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeLedgerHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Hash</a>
|
||||
<a href="modules.html#hashLedger" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeLedgerHeaderHash" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash</a>
|
||||
<a href="modules.html#hashLedgerHeader" class="tsd-kind-icon">compute<wbr>Ledger<wbr>Header<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeOfferIndex" class="tsd-kind-icon">compute<wbr>Offer<wbr>Index</a>
|
||||
<a href="modules.html#hashOfferId" class="tsd-kind-icon">compute<wbr>Offer<wbr>Index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computePaymentChannelHash" class="tsd-kind-icon">compute<wbr>Payment<wbr>Channel<wbr>Hash</a>
|
||||
<a href="modules.html#hashPaymentChannel" class="tsd-kind-icon">compute<wbr>Payment<wbr>Channel<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeSignerListIndex" class="tsd-kind-icon">compute<wbr>Signer<wbr>List<wbr>Index</a>
|
||||
<a href="modules.html#hashSignerListId" class="tsd-kind-icon">compute<wbr>Signer<wbr>List<wbr>Index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeStateTreeHash" class="tsd-kind-icon">compute<wbr>State<wbr>Tree<wbr>Hash</a>
|
||||
<a href="modules.html#hashStateTree" class="tsd-kind-icon">compute<wbr>State<wbr>Tree<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeTransactionHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeTransactionTreeHash" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Tree<wbr>Hash</a>
|
||||
<a href="modules.html#hashTxTree" class="tsd-kind-icon">compute<wbr>Transaction<wbr>Tree<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#computeTrustlineHash" class="tsd-kind-icon">compute<wbr>Trustline<wbr>Hash</a>
|
||||
<a href="modules.html#hashTrustline" class="tsd-kind-icon">compute<wbr>Trustline<wbr>Hash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="modules.html#convertKeysFromSnakeCaseToCamelCase" class="tsd-kind-icon">convert<wbr>Keys<wbr>From<wbr>Snake<wbr>Case<wbr>ToCamel<wbr>Case</a>
|
||||
@@ -1425,4 +1425,4 @@
|
||||
<div class="overlay"></div>
|
||||
<script src="assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user