ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-20 04:05:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deprecate mnemonic (#2155)

Browse Source
This commit is contained in:
jonathanlei
2022-12-15 11:11:28 -08:00
committed by GitHub
parent 51affe19b7
commit 46515627ab
3 changed files with 33 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/classes/Wallet.html
View File

@@ -18,7 +18,7 @@
A wallet can be derived from either a seed, mnemonic, or entropy (array of random numbers).
It provides functionality to sign/verify transactions offline.</p>
<h3>Example</h3><pre><code class="language-typescript"><span class="hl-8">// Derive a wallet from a bip39 Mnemonic</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">wallet</span><span class="hl-1"> = </span><span class="hl-0">Wallet</span><span class="hl-1">.</span><span class="hl-4">fromMnemonic</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-5">&#39;jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry&#39;</span><br/><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">wallet</span><span class="hl-1">)</span><br/><span class="hl-8">// Wallet {</span><br/><span class="hl-8">// publicKey: &#39;02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2&#39;,</span><br/><span class="hl-8">// privateKey: &#39;00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2&#39;,</span><br/><span class="hl-8">// classicAddress: &#39;rwZiksrExmVkR64pf87Jor4cYbmff47SUm&#39;,</span><br/><span class="hl-8">// seed: undefined</span><br/><span class="hl-8">// }.</span><br/><br/><span class="hl-8">// Derive a wallet from a base58 encoded seed.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">seedWallet</span><span class="hl-1"> = </span><span class="hl-0">Wallet</span><span class="hl-1">.</span><span class="hl-4">fromSeed</span><span class="hl-1">(</span><span class="hl-5">&#39;ssZkdwURFMBXenJPbrpE14b6noJSu&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">seedWallet</span><span class="hl-1">)</span><br/><span class="hl-8">// Wallet {</span><br/><span class="hl-8">// publicKey: &#39;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#39;,</span><br/><span class="hl-8">// privateKey: &#39;00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7&#39;,</span><br/><span class="hl-8">// classicAddress: &#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;,</span><br/><span class="hl-8">// seed: &#39;ssZkdwURFMBXenJPbrpE14b6noJSu&#39;</span><br/><span class="hl-8">// }.</span><br/><br/><span class="hl-8">// Sign a JSON Transaction</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">signed</span><span class="hl-1"> = </span><span class="hl-0">seedWallet</span><span class="hl-1">.</span><span class="hl-4">signTransaction</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;Payment&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-5">&#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;</span><br/><span class="hl-1"> ...........</span><br/><span class="hl-1">}).</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">signed</span><span class="hl-1">)</span><br/><span class="hl-8">// &#39;1200007321......B01BE1DFF3&#39;.</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">decode</span><span class="hl-1">(</span><span class="hl-0">signed</span><span class="hl-1">))</span><br/><span class="hl-8">// {</span><br/><span class="hl-8">// TransactionType: &#39;Payment&#39;,</span><br/><span class="hl-8">// SigningPubKey: &#39;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#39;,</span><br/><span class="hl-8">// TxnSignature: &#39;3045022100AAD......5B631ABD21171B61B07D304&#39;,</span><br/><span class="hl-8">// Account: &#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;</span><br/><span class="hl-8">// ...........</span><br/><span class="hl-8">// }</span>
<h3>Example</h3><pre><code class="language-typescript"><br/><span class="hl-8">// Derive a wallet from a base58 encoded seed.</span><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">seedWallet</span><span class="hl-1"> = </span><span class="hl-0">Wallet</span><span class="hl-1">.</span><span class="hl-4">fromSeed</span><span class="hl-1">(</span><span class="hl-5">&#39;ssZkdwURFMBXenJPbrpE14b6noJSu&#39;</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">seedWallet</span><span class="hl-1">)</span><br/><span class="hl-8">// Wallet {</span><br/><span class="hl-8">// publicKey: &#39;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#39;,</span><br/><span class="hl-8">// privateKey: &#39;00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7&#39;,</span><br/><span class="hl-8">// classicAddress: &#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;,</span><br/><span class="hl-8">// seed: &#39;ssZkdwURFMBXenJPbrpE14b6noJSu&#39;</span><br/><span class="hl-8">// }.</span><br/><br/><span class="hl-8">// Sign a JSON Transaction</span><br/><span class="hl-1"> </span><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">signed</span><span class="hl-1"> = </span><span class="hl-0">seedWallet</span><span class="hl-1">.</span><span class="hl-4">signTransaction</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">TransactionType:</span><span class="hl-1"> </span><span class="hl-5">&#39;Payment&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">Account:</span><span class="hl-1"> </span><span class="hl-5">&#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;</span><br/><span class="hl-1"> ...........</span><br/><span class="hl-1">}).</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-0">signed</span><span class="hl-1">)</span><br/><span class="hl-8">// &#39;1200007321......B01BE1DFF3&#39;.</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">decode</span><span class="hl-1">(</span><span class="hl-0">signed</span><span class="hl-1">))</span><br/><span class="hl-8">// {</span><br/><span class="hl-8">// TransactionType: &#39;Payment&#39;,</span><br/><span class="hl-8">// SigningPubKey: &#39;02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449&#39;,</span><br/><span class="hl-8">// TxnSignature: &#39;3045022100AAD......5B631ABD21171B61B07D304&#39;,</span><br/><span class="hl-8">// Account: &#39;rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo&#39;</span><br/><span class="hl-8">// ...........</span><br/><span class="hl-8">// }</span>
</code></pre>
</div></section>
<section class="tsd-panel tsd-hierarchy">
@@ -26,7 +26,7 @@ It provides functionality to sign/verify transactions offline.</p>
<ul class="tsd-hierarchy">
<li><span class="target">Wallet</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L94">packages/xrpl/src/Wallet/index.ts:94</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L83">packages/xrpl/src/Wallet/index.ts:83</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">
@@ -96,29 +96,29 @@ It provides functionality to sign/verify transactions offline.</p>
</div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L118">packages/xrpl/src/Wallet/index.ts:118</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L107">packages/xrpl/src/Wallet/index.ts:107</a></li></ul></aside></li></ul></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-class"><a id="classicAddress" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>classic<wbr/>Address</span><a href="#classicAddress" 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">classic<wbr/>Address<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/8921b6ac/packages/xrpl/src/Wallet/index.ts#L97">packages/xrpl/src/Wallet/index.ts:97</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L86">packages/xrpl/src/Wallet/index.ts:86</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="privateKey" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>private<wbr/>Key</span><a href="#privateKey" 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">private<wbr/>Key<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/8921b6ac/packages/xrpl/src/Wallet/index.ts#L96">packages/xrpl/src/Wallet/index.ts:96</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L85">packages/xrpl/src/Wallet/index.ts:85</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="publicKey" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>public<wbr/>Key</span><a href="#publicKey" 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">public<wbr/>Key<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/8921b6ac/packages/xrpl/src/Wallet/index.ts#L95">packages/xrpl/src/Wallet/index.ts:95</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L84">packages/xrpl/src/Wallet/index.ts:84</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="seed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>seed</span><a href="#seed" 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">seed<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/8921b6ac/packages/xrpl/src/Wallet/index.ts#L98">packages/xrpl/src/Wallet/index.ts:98</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L87">packages/xrpl/src/Wallet/index.ts:87</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="fromSecret" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Secret</span><a href="#fromSecret" 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">from<wbr/>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ECDSA</span><span class="tsd-signature-symbol">; </span>masterAddress<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-symbol"> =&gt; </span><a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = Wallet.fromSeed</span></div>
@@ -155,7 +155,7 @@ It provides functionality to sign/verify transactions offline.</p>
</div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L174">packages/xrpl/src/Wallet/index.ts:174</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L163">packages/xrpl/src/Wallet/index.ts:163</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="address" class="tsd-anchor"></a>
@@ -169,7 +169,7 @@ It provides functionality to sign/verify transactions offline.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L105">packages/xrpl/src/Wallet/index.ts:105</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L94">packages/xrpl/src/Wallet/index.ts:94</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="checkTxSerialization" class="tsd-anchor"></a>
@@ -199,7 +199,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L411">packages/xrpl/src/Wallet/index.ts:411</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L405">packages/xrpl/src/Wallet/index.ts:405</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getXAddress" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>getXAddress</span><a href="#getXAddress" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -222,7 +222,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L395">packages/xrpl/src/Wallet/index.ts:395</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L389">packages/xrpl/src/Wallet/index.ts:389</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="sign" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>sign</span><a href="#sign" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -258,7 +258,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
<li class="tsd-parameter">
<h5>tx_<wbr/>blob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L317">packages/xrpl/src/Wallet/index.ts:317</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L311">packages/xrpl/src/Wallet/index.ts:311</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="verifyTransaction" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>verify<wbr/>Transaction</span><a href="#verifyTransaction" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -277,7 +277,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L378">packages/xrpl/src/Wallet/index.ts:378</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L372">packages/xrpl/src/Wallet/index.ts:372</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="deriveWallet" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>derive<wbr/>Wallet</span><a href="#deriveWallet" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -309,7 +309,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L293">packages/xrpl/src/Wallet/index.ts:293</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L287">packages/xrpl/src/Wallet/index.ts:287</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromEntropy" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Entropy</span><a href="#fromEntropy" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -341,7 +341,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L185">packages/xrpl/src/Wallet/index.ts:185</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L174">packages/xrpl/src/Wallet/index.ts:174</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromMnemonic" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Mnemonic</span><a href="#fromMnemonic" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -349,6 +349,11 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Derives a wallet from a bip39 or RFC1751 mnemonic (Defaults to bip39).</p>
<h3>Deprecated</h3><p>since version 2.6.1.
Will be deleted in version 3.0.0.
This representation is currently deprecated in rippled.
You should use another method to represent your keys such as a seed or public/private keypair.</p>
<h3>Returns</h3><p>A Wallet derived from a mnemonic.</p>
<h3>Throws</h3><p>ValidationError if unable to derive private key from mnemonic input.</p>
@@ -386,7 +391,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L216">packages/xrpl/src/Wallet/index.ts:216</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L210">packages/xrpl/src/Wallet/index.ts:210</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fromRFC1751Mnemonic" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>fromRFC1751<wbr/>Mnemonic</span><a href="#fromRFC1751Mnemonic" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -418,7 +423,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L265">packages/xrpl/src/Wallet/index.ts:265</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L259">packages/xrpl/src/Wallet/index.ts:259</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fromSeed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Seed</span><a href="#fromSeed" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -450,7 +455,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L154">packages/xrpl/src/Wallet/index.ts:154</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L143">packages/xrpl/src/Wallet/index.ts:143</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="generate" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>generate</span><a href="#generate" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -469,7 +474,7 @@ the serialized Transaction desn&#39;t match the original transaction.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="Wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/Wallet/index.ts#L140">packages/xrpl/src/Wallet/index.ts:140</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/ff7e745e/packages/xrpl/src/Wallet/index.ts#L129">packages/xrpl/src/Wallet/index.ts:129</a></li></ul></aside></li></ul></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">