@leocuvee/turtlecoin-utils 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/.github/workflows/ci.yml +27 -0
  2. package/.idea/codeStyles/codeStyleConfig.xml +5 -0
  3. package/.idea/inspectionProfiles/Project_Default.xml +7 -0
  4. package/.idea/misc.xml +6 -0
  5. package/.idea/modules.xml +8 -0
  6. package/.idea/turtlecoin-utils.iml +12 -0
  7. package/.idea/vcs.xml +6 -0
  8. package/.travis.yml +11 -0
  9. package/CONTRIBUTING.md +3 -0
  10. package/LICENSE +674 -0
  11. package/README.md +203 -0
  12. package/config.json +7 -0
  13. package/docs/.nojekyll +0 -0
  14. package/docs/CNAME +1 -0
  15. package/docs/assets/css/main.css +2321 -0
  16. package/docs/assets/images/icons.png +0 -0
  17. package/docs/assets/images/icons@2x.png +0 -0
  18. package/docs/assets/images/widgets.png +0 -0
  19. package/docs/assets/images/widgets@2x.png +0 -0
  20. package/docs/assets/js/main.js +1 -0
  21. package/docs/assets/js/search.js +3 -0
  22. package/docs/classes/address.html +964 -0
  23. package/docs/classes/addressprefix.html +431 -0
  24. package/docs/classes/block.html +965 -0
  25. package/docs/classes/blocktemplate.html +695 -0
  26. package/docs/classes/cryptonote.html +1137 -0
  27. package/docs/classes/ed25519.keypair.html +400 -0
  28. package/docs/classes/ed25519.keys.html +373 -0
  29. package/docs/classes/extranoncetag.extranoncedata.html +454 -0
  30. package/docs/classes/extranoncetag.extranoncepaymentid.html +453 -0
  31. package/docs/classes/extranoncetag.iextranonce.html +347 -0
  32. package/docs/classes/extratag.extramergedmining.html +494 -0
  33. package/docs/classes/extratag.extranonce.html +530 -0
  34. package/docs/classes/extratag.extrapadding.html +456 -0
  35. package/docs/classes/extratag.extrapublickey.html +460 -0
  36. package/docs/classes/extratag.iextratag.html +355 -0
  37. package/docs/classes/levinpacket.html +674 -0
  38. package/docs/classes/levinpayloads.handshake.html +731 -0
  39. package/docs/classes/levinpayloads.ilevinpayload.html +318 -0
  40. package/docs/classes/levinpayloads.liteblock.html +494 -0
  41. package/docs/classes/levinpayloads.missingtransactions.html +494 -0
  42. package/docs/classes/levinpayloads.newblock.html +540 -0
  43. package/docs/classes/levinpayloads.newtransactions.html +402 -0
  44. package/docs/classes/levinpayloads.peerentry.html +610 -0
  45. package/docs/classes/levinpayloads.ping.html +450 -0
  46. package/docs/classes/levinpayloads.rawblock.html +344 -0
  47. package/docs/classes/levinpayloads.requestchain.html +402 -0
  48. package/docs/classes/levinpayloads.requestgetobjects.html +448 -0
  49. package/docs/classes/levinpayloads.requesttxpool.html +402 -0
  50. package/docs/classes/levinpayloads.responsechain.html +494 -0
  51. package/docs/classes/levinpayloads.responsegetobjects.html +540 -0
  52. package/docs/classes/levinpayloads.timedsync.html +540 -0
  53. package/docs/classes/multisig.html +930 -0
  54. package/docs/classes/multisigmessage.html +694 -0
  55. package/docs/classes/parentblock.html +347 -0
  56. package/docs/classes/transaction.html +925 -0
  57. package/docs/classes/transactioninputs.coinbaseinput.html +390 -0
  58. package/docs/classes/transactioninputs.itransactioninput.html +321 -0
  59. package/docs/classes/transactioninputs.keyinput.html +459 -0
  60. package/docs/classes/transactionoutputs.itransactionoutput.html +317 -0
  61. package/docs/classes/transactionoutputs.keyoutput.html +422 -0
  62. package/docs/enums/extranoncetag.noncetagtype.html +246 -0
  63. package/docs/enums/extratag.extratagtype.html +280 -0
  64. package/docs/enums/levinprotocol.commandtype.html +391 -0
  65. package/docs/enums/transactioninputs.inputtype.html +246 -0
  66. package/docs/enums/transactionoutputs.outputtype.html +229 -0
  67. package/docs/globals.html +238 -0
  68. package/docs/index.html +271 -0
  69. package/docs/interfaces/interfaces.config.html +590 -0
  70. package/docs/interfaces/interfaces.daemonblocktemplateresponse.html +323 -0
  71. package/docs/interfaces/interfaces.generatedinput.html +304 -0
  72. package/docs/interfaces/interfaces.generatedoutput.html +285 -0
  73. package/docs/interfaces/interfaces.inputkeys.html +304 -0
  74. package/docs/interfaces/interfaces.ipreparedtransaction.html +268 -0
  75. package/docs/interfaces/interfaces.output.html +399 -0
  76. package/docs/interfaces/interfaces.preparedringsignature.html +377 -0
  77. package/docs/interfaces/interfaces.preparedtransaction.html +329 -0
  78. package/docs/interfaces/interfaces.randomoutput.html +285 -0
  79. package/docs/interfaces/interfaces.transactionrecipient.html +285 -0
  80. package/docs/interfaces/multisiginterfaces.partialkeyimage.html +277 -0
  81. package/docs/interfaces/multisiginterfaces.partialsigningkey.html +277 -0
  82. package/docs/modules/ed25519.html +195 -0
  83. package/docs/modules/extranoncetag.html +208 -0
  84. package/docs/modules/extratag.html +216 -0
  85. package/docs/modules/interfaces.html +231 -0
  86. package/docs/modules/levinpayloads.html +247 -0
  87. package/docs/modules/levinprotocol.html +191 -0
  88. package/docs/modules/multisiginterfaces.html +195 -0
  89. package/docs/modules/transactioninputs.html +208 -0
  90. package/docs/modules/transactionoutputs.html +204 -0
  91. package/index.d.ts +417 -0
  92. package/index.js +1508 -0
  93. package/lib/base58.js +220 -0
  94. package/lib/biginteger.js +1591 -0
  95. package/lib/blocktemplate.js +408 -0
  96. package/lib/crypto.js +19698 -0
  97. package/lib/mnemonic.js +1204 -0
  98. package/lib/nacl-fast-cn.js +608 -0
  99. package/lib/ringsigs.js +24262 -0
  100. package/lib/sha3.js +477 -0
  101. package/package.json +58 -0
  102. package/src/Address.ts +433 -0
  103. package/src/AddressPrefix.ts +117 -0
  104. package/src/Block.ts +556 -0
  105. package/src/BlockTemplate.ts +289 -0
  106. package/src/Common.ts +105 -0
  107. package/src/Config.ts +66 -0
  108. package/src/CryptoNote.ts +1072 -0
  109. package/src/LevinPacket.ts +366 -0
  110. package/src/Multisig.ts +600 -0
  111. package/src/MultisigMessage.ts +374 -0
  112. package/src/ParentBlock.ts +39 -0
  113. package/src/Transaction.ts +628 -0
  114. package/src/Types/ED25519.ts +187 -0
  115. package/src/Types/IExtraNonce.ts +225 -0
  116. package/src/Types/IExtraTag.ts +507 -0
  117. package/src/Types/ITransaction.ts +230 -0
  118. package/src/Types/ITransactionInput.ts +190 -0
  119. package/src/Types/ITransactionOutput.ts +108 -0
  120. package/src/Types/LevinPayloads.ts +1576 -0
  121. package/src/Types/MultisigInterfaces.ts +65 -0
  122. package/src/Types/PortableStorage.ts +289 -0
  123. package/src/Types.ts +36 -0
  124. package/src/index.ts +36 -0
  125. package/test/template.json +6 -0
  126. package/test/test.js +1457 -0
  127. package/tests/blocktemplate.json +6 -0
  128. package/tests/tests.js +215 -0
  129. package/tsconfig.json +15 -0
  130. package/tslint.json +36 -0
  131. package/typedoc.json +10 -0
  132. package/webpack.config.js +15 -0
package/docs/classes/address.html ADDED
@@ -0,0 +1,964 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>Address | TurtleCoin-Utils</title>
7
+ <meta name="description" content="">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ </head>
11
+ <body>
12
+ <header>
13
+ <div class="tsd-page-toolbar">
14
+ <div class="container">
15
+ <div class="table-wrap">
16
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
+ <div class="field">
18
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
+ <input id="tsd-search-field" type="text" />
20
+ </div>
21
+ <ul class="results">
22
+ <li class="state loading">Preparing search index...</li>
23
+ <li class="state failure">The search index is not available</li>
24
+ </ul>
25
+ <a href="../index.html" class="title">TurtleCoin-Utils</a>
26
+ </div>
27
+ <div class="table-cell" id="tsd-widgets">
28
+ <div id="tsd-filter">
29
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
+ <div class="tsd-filter-group">
31
+ <div class="tsd-select" id="tsd-filter-visibility">
32
+ <span class="tsd-select-label">All</span>
33
+ <ul class="tsd-select-list">
34
+ <li data-value="public">Public</li>
35
+ <li data-value="protected">Public/Protected</li>
36
+ <li data-value="private" class="selected">All</li>
37
+ </ul>
38
+ </div>
39
+ <input type="checkbox" id="tsd-filter-inherited" checked />
40
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
+ </div>
42
+ </div>
43
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
44
+ </div>
45
+ </div>
46
+ </div>
47
+ </div>
48
+ <div class="tsd-page-title">
49
+ <div class="container">
50
+ <ul class="tsd-breadcrumb">
51
+ <li>
52
+ <a href="../globals.html">Globals</a>
53
+ </li>
54
+ <li>
55
+ <a href="address.html">Address</a>
56
+ </li>
57
+ </ul>
58
+ <h1>Class Address</h1>
59
+ </div>
60
+ </div>
61
+ </header>
62
+ <div class="container container-main">
63
+ <div class="row">
64
+ <div class="col-8 col-content">
65
+ <section class="tsd-panel tsd-comment">
66
+ <div class="tsd-comment tsd-typography">
67
+ <div class="lead">
68
+ <p>Represents a TurtleCoin address</p>
69
+ </div>
70
+ </div>
71
+ </section>
72
+ <section class="tsd-panel tsd-hierarchy">
73
+ <h3>Hierarchy</h3>
74
+ <ul class="tsd-hierarchy">
75
+ <li>
76
+ <span class="target">Address</span>
77
+ </li>
78
+ </ul>
79
+ </section>
80
+ <section class="tsd-panel-group tsd-index-group">
81
+ <h2>Index</h2>
82
+ <section class="tsd-panel tsd-index-panel">
83
+ <div class="tsd-index-content">
84
+ <section class="tsd-index-section ">
85
+ <h3>Accessors</h3>
86
+ <ul class="tsd-index-list">
87
+ <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="address.html#address-1" class="tsd-kind-icon">address</a></li>
88
+ <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="address.html#mnemonic" class="tsd-kind-icon">mnemonic</a></li>
89
+ <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="address.html#paymentid" class="tsd-kind-icon">payment<wbr>Id</a></li>
90
+ <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="address.html#prefix" class="tsd-kind-icon">prefix</a></li>
91
+ <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="address.html#seed" class="tsd-kind-icon">seed</a></li>
92
+ <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="address.html#spend" class="tsd-kind-icon">spend</a></li>
93
+ <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="address.html#subwalletindex" class="tsd-kind-icon">subwallet<wbr>Index</a></li>
94
+ <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="address.html#view" class="tsd-kind-icon">view</a></li>
95
+ </ul>
96
+ </section>
97
+ <section class="tsd-index-section ">
98
+ <h3>Methods</h3>
99
+ <ul class="tsd-index-list">
100
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="address.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
101
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#encoderaw" class="tsd-kind-icon">encode<wbr>Raw</a></li>
102
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#fromaddress" class="tsd-kind-icon">from<wbr>Address</a></li>
103
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#fromentropy" class="tsd-kind-icon">from<wbr>Entropy</a></li>
104
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#fromkeys" class="tsd-kind-icon">from<wbr>Keys</a></li>
105
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#frommnemonic" class="tsd-kind-icon">from<wbr>Mnemonic</a></li>
106
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#frompublickeys" class="tsd-kind-icon">from<wbr>Public<wbr>Keys</a></li>
107
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#fromseed" class="tsd-kind-icon">from<wbr>Seed</a></li>
108
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#fromviewonlykeys" class="tsd-kind-icon">from<wbr>View<wbr>Only<wbr>Keys</a></li>
109
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#generateseed" class="tsd-kind-icon">generate<wbr>Seed</a></li>
110
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="address.html#generatesubwallet" class="tsd-kind-icon">generate<wbr>Subwallet</a></li>
111
+ </ul>
112
+ </section>
113
+ </div>
114
+ </section>
115
+ </section>
116
+ <section class="tsd-panel-group tsd-member-group ">
117
+ <h2>Accessors</h2>
118
+ <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
119
+ <a name="address-1" class="tsd-anchor"></a>
120
+ <h3>address</h3>
121
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
122
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> address<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>
123
+ </ul>
124
+ <ul class="tsd-descriptions">
125
+ <li class="tsd-description">
126
+ <aside class="tsd-sources">
127
+ <ul>
128
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L37">Address.ts:37</a></li>
129
+ </ul>
130
+ </aside>
131
+ <div class="tsd-comment tsd-typography">
132
+ <div class="lead">
133
+ <p>The Base58 encoded address</p>
134
+ </div>
135
+ </div>
136
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
137
+ </li>
138
+ </ul>
139
+ </section>
140
+ <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
141
+ <a name="mnemonic" class="tsd-anchor"></a>
142
+ <h3>mnemonic</h3>
143
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
144
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> mnemonic<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
145
+ </ul>
146
+ <ul class="tsd-descriptions">
147
+ <li class="tsd-description">
148
+ <aside class="tsd-sources">
149
+ <ul>
150
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L58">Address.ts:58</a></li>
151
+ </ul>
152
+ </aside>
153
+ <div class="tsd-comment tsd-typography">
154
+ <div class="lead">
155
+ <p>The mnemonic phrase for the address if available</p>
156
+ </div>
157
+ </div>
158
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
159
+ </li>
160
+ </ul>
161
+ </section>
162
+ <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
163
+ <a name="paymentid" class="tsd-anchor"></a>
164
+ <h3>payment<wbr>Id</h3>
165
+ <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
166
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paymentId<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>
167
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> paymentId<span class="tsd-signature-symbol">(</span>paymentId<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">void</span></li>
168
+ </ul>
169
+ <ul class="tsd-descriptions">
170
+ <li class="tsd-description">
171
+ <aside class="tsd-sources">
172
+ <ul>
173
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L65">Address.ts:65</a></li>
174
+ </ul>
175
+ </aside>
176
+ <div class="tsd-comment tsd-typography">
177
+ <div class="lead">
178
+ <p>The payment Id of the address if one exists</p>
179
+ </div>
180
+ </div>
181
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
182
+ </li>
183
+ <li class="tsd-description">
184
+ <aside class="tsd-sources">
185
+ <ul>
186
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L71">Address.ts:71</a></li>
187
+ </ul>
188
+ </aside>
189
+ <div class="tsd-comment tsd-typography">
190
+ <div class="lead">
191
+ <p>The payment Id of the address if one exists</p>
192
+ </div>
193
+ </div>
194
+ <h4 class="tsd-parameters-title">Parameters</h4>
195
+ <ul class="tsd-parameters">
196
+ <li>
197
+ <h5>paymentId: <span class="tsd-signature-type">string</span></h5>
198
+ </li>
199
+ </ul>
200
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
201
+ </li>
202
+ </ul>
203
+ </section>
204
+ <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
205
+ <a name="prefix" class="tsd-anchor"></a>
206
+ <h3>prefix</h3>
207
+ <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
208
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> prefix<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a></li>
209
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> prefix<span class="tsd-signature-symbol">(</span>addressPrefix<span class="tsd-signature-symbol">: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
210
+ </ul>
211
+ <ul class="tsd-descriptions">
212
+ <li class="tsd-description">
213
+ <aside class="tsd-sources">
214
+ <ul>
215
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L82">Address.ts:82</a></li>
216
+ </ul>
217
+ </aside>
218
+ <div class="tsd-comment tsd-typography">
219
+ <div class="lead">
220
+ <p>The address prefix</p>
221
+ </div>
222
+ </div>
223
+ <h4 class="tsd-returns-title">Returns <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a></h4>
224
+ </li>
225
+ <li class="tsd-description">
226
+ <aside class="tsd-sources">
227
+ <ul>
228
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L86">Address.ts:86</a></li>
229
+ </ul>
230
+ </aside>
231
+ <div class="tsd-comment tsd-typography">
232
+ <div class="lead">
233
+ <p>The address prefix</p>
234
+ </div>
235
+ </div>
236
+ <h4 class="tsd-parameters-title">Parameters</h4>
237
+ <ul class="tsd-parameters">
238
+ <li>
239
+ <h5>addressPrefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a></h5>
240
+ </li>
241
+ </ul>
242
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
243
+ </li>
244
+ </ul>
245
+ </section>
246
+ <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
247
+ <a name="seed" class="tsd-anchor"></a>
248
+ <h3>seed</h3>
249
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
250
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> seed<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
251
+ </ul>
252
+ <ul class="tsd-descriptions">
253
+ <li class="tsd-description">
254
+ <aside class="tsd-sources">
255
+ <ul>
256
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L51">Address.ts:51</a></li>
257
+ </ul>
258
+ </aside>
259
+ <div class="tsd-comment tsd-typography">
260
+ <div class="lead">
261
+ <p>The seed phrase for the address if available</p>
262
+ </div>
263
+ </div>
264
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
265
+ </li>
266
+ </ul>
267
+ </section>
268
+ <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
269
+ <a name="spend" class="tsd-anchor"></a>
270
+ <h3>spend</h3>
271
+ <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
272
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> spend<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a></li>
273
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> spend<span class="tsd-signature-symbol">(</span>keys<span class="tsd-signature-symbol">: </span><a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
274
+ </ul>
275
+ <ul class="tsd-descriptions">
276
+ <li class="tsd-description">
277
+ <aside class="tsd-sources">
278
+ <ul>
279
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L93">Address.ts:93</a></li>
280
+ </ul>
281
+ </aside>
282
+ <div class="tsd-comment tsd-typography">
283
+ <div class="lead">
284
+ <p>The address spend keys</p>
285
+ </div>
286
+ </div>
287
+ <h4 class="tsd-returns-title">Returns <a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a></h4>
288
+ </li>
289
+ <li class="tsd-description">
290
+ <aside class="tsd-sources">
291
+ <ul>
292
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L97">Address.ts:97</a></li>
293
+ </ul>
294
+ </aside>
295
+ <div class="tsd-comment tsd-typography">
296
+ <div class="lead">
297
+ <p>The address spend keys</p>
298
+ </div>
299
+ </div>
300
+ <h4 class="tsd-parameters-title">Parameters</h4>
301
+ <ul class="tsd-parameters">
302
+ <li>
303
+ <h5>keys: <a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a></h5>
304
+ </li>
305
+ </ul>
306
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
307
+ </li>
308
+ </ul>
309
+ </section>
310
+ <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
311
+ <a name="subwalletindex" class="tsd-anchor"></a>
312
+ <h3>subwallet<wbr>Index</h3>
313
+ <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
314
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> subwalletIndex<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
315
+ </ul>
316
+ <ul class="tsd-descriptions">
317
+ <li class="tsd-description">
318
+ <aside class="tsd-sources">
319
+ <ul>
320
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L44">Address.ts:44</a></li>
321
+ </ul>
322
+ </aside>
323
+ <div class="tsd-comment tsd-typography">
324
+ <div class="lead">
325
+ <p>The address index number [0=primary]</p>
326
+ </div>
327
+ </div>
328
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
329
+ </li>
330
+ </ul>
331
+ </section>
332
+ <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
333
+ <a name="view" class="tsd-anchor"></a>
334
+ <h3>view</h3>
335
+ <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
336
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> view<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a></li>
337
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> view<span class="tsd-signature-symbol">(</span>keys<span class="tsd-signature-symbol">: </span><a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
338
+ </ul>
339
+ <ul class="tsd-descriptions">
340
+ <li class="tsd-description">
341
+ <aside class="tsd-sources">
342
+ <ul>
343
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L104">Address.ts:104</a></li>
344
+ </ul>
345
+ </aside>
346
+ <div class="tsd-comment tsd-typography">
347
+ <div class="lead">
348
+ <p>The address view keys</p>
349
+ </div>
350
+ </div>
351
+ <h4 class="tsd-returns-title">Returns <a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a></h4>
352
+ </li>
353
+ <li class="tsd-description">
354
+ <aside class="tsd-sources">
355
+ <ul>
356
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L108">Address.ts:108</a></li>
357
+ </ul>
358
+ </aside>
359
+ <div class="tsd-comment tsd-typography">
360
+ <div class="lead">
361
+ <p>The address view keys</p>
362
+ </div>
363
+ </div>
364
+ <h4 class="tsd-parameters-title">Parameters</h4>
365
+ <ul class="tsd-parameters">
366
+ <li>
367
+ <h5>keys: <a href="ed25519.keypair.html" class="tsd-signature-type">KeyPair</a></h5>
368
+ </li>
369
+ </ul>
370
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
371
+ </li>
372
+ </ul>
373
+ </section>
374
+ </section>
375
+ <section class="tsd-panel-group tsd-member-group ">
376
+ <h2>Methods</h2>
377
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
378
+ <a name="tostring" class="tsd-anchor"></a>
379
+ <h3>to<wbr>String</h3>
380
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
381
+ <li class="tsd-signature tsd-kind-icon">to<wbr>String<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>
382
+ </ul>
383
+ <ul class="tsd-descriptions">
384
+ <li class="tsd-description">
385
+ <aside class="tsd-sources">
386
+ <ul>
387
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L406">Address.ts:406</a></li>
388
+ </ul>
389
+ </aside>
390
+ <div class="tsd-comment tsd-typography">
391
+ <div class="lead">
392
+ <p>Returns the Base58 encoded address</p>
393
+ </div>
394
+ </div>
395
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
396
+ <p>Base58 encoded address</p>
397
+ </li>
398
+ </ul>
399
+ </section>
400
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
401
+ <a name="encoderaw" class="tsd-anchor"></a>
402
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> encode<wbr>Raw</h3>
403
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
404
+ <li class="tsd-signature tsd-kind-icon">encode<wbr>Raw<span class="tsd-signature-symbol">(</span>rawAddress<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>
405
+ </ul>
406
+ <ul class="tsd-descriptions">
407
+ <li class="tsd-description">
408
+ <aside class="tsd-sources">
409
+ <ul>
410
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L390">Address.ts:390</a></li>
411
+ </ul>
412
+ </aside>
413
+ <div class="tsd-comment tsd-typography">
414
+ <div class="lead">
415
+ <p>Encodes a raw address (hex) into Base58 notation</p>
416
+ </div>
417
+ <dl class="tsd-comment-tags">
418
+ <dt>retursn</dt>
419
+ <dd><p>the Base58 representation of the address</p>
420
+ </dd>
421
+ </dl>
422
+ </div>
423
+ <h4 class="tsd-parameters-title">Parameters</h4>
424
+ <ul class="tsd-parameters">
425
+ <li>
426
+ <h5>rawAddress: <span class="tsd-signature-type">string</span></h5>
427
+ <div class="tsd-comment tsd-typography">
428
+ <p>the raw address in hexadecimal form</p>
429
+ </div>
430
+ </li>
431
+ </ul>
432
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
433
+ </li>
434
+ </ul>
435
+ </section>
436
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
437
+ <a name="fromaddress" class="tsd-anchor"></a>
438
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Address</h3>
439
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
440
+ <li class="tsd-signature tsd-kind-icon">from<wbr>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
441
+ </ul>
442
+ <ul class="tsd-descriptions">
443
+ <li class="tsd-description">
444
+ <aside class="tsd-sources">
445
+ <ul>
446
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L118">Address.ts:118</a></li>
447
+ </ul>
448
+ </aside>
449
+ <div class="tsd-comment tsd-typography">
450
+ <div class="lead">
451
+ <p>Creates a new address object from a Base58 address</p>
452
+ </div>
453
+ </div>
454
+ <h4 class="tsd-parameters-title">Parameters</h4>
455
+ <ul class="tsd-parameters">
456
+ <li>
457
+ <h5>address: <span class="tsd-signature-type">string</span></h5>
458
+ <div class="tsd-comment tsd-typography">
459
+ <p>the public address to decode</p>
460
+ </div>
461
+ </li>
462
+ <li>
463
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
464
+ </li>
465
+ </ul>
466
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
467
+ <p>a new address object</p>
468
+ </li>
469
+ </ul>
470
+ </section>
471
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
472
+ <a name="fromentropy" class="tsd-anchor"></a>
473
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Entropy</h3>
474
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
475
+ <li class="tsd-signature tsd-kind-icon">from<wbr>Entropy<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
476
+ </ul>
477
+ <ul class="tsd-descriptions">
478
+ <li class="tsd-description">
479
+ <aside class="tsd-sources">
480
+ <ul>
481
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L323">Address.ts:323</a></li>
482
+ </ul>
483
+ </aside>
484
+ <div class="tsd-comment tsd-typography">
485
+ <div class="lead">
486
+ <p>Creates a new address object from entropy (new address)</p>
487
+ </div>
488
+ </div>
489
+ <h4 class="tsd-parameters-title">Parameters</h4>
490
+ <ul class="tsd-parameters">
491
+ <li>
492
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> entropy: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
493
+ </li>
494
+ <li>
495
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> language: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
496
+ </li>
497
+ <li>
498
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
499
+ </li>
500
+ </ul>
501
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
502
+ <p>a new address object</p>
503
+ </li>
504
+ </ul>
505
+ </section>
506
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
507
+ <a name="fromkeys" class="tsd-anchor"></a>
508
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Keys</h3>
509
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
510
+ <li class="tsd-signature tsd-kind-icon">from<wbr>Keys<span class="tsd-signature-symbol">(</span>privateSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateViewKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
511
+ </ul>
512
+ <ul class="tsd-descriptions">
513
+ <li class="tsd-description">
514
+ <aside class="tsd-sources">
515
+ <ul>
516
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L242">Address.ts:242</a></li>
517
+ </ul>
518
+ </aside>
519
+ <div class="tsd-comment tsd-typography">
520
+ <div class="lead">
521
+ <p>Creates a new address object using the supplied private keys</p>
522
+ </div>
523
+ </div>
524
+ <h4 class="tsd-parameters-title">Parameters</h4>
525
+ <ul class="tsd-parameters">
526
+ <li>
527
+ <h5>privateSpendKey: <span class="tsd-signature-type">string</span></h5>
528
+ <div class="tsd-comment tsd-typography">
529
+ <p>the private spend key</p>
530
+ </div>
531
+ </li>
532
+ <li>
533
+ <h5>privateViewKey: <span class="tsd-signature-type">string</span></h5>
534
+ <div class="tsd-comment tsd-typography">
535
+ <p>the private view key</p>
536
+ </div>
537
+ </li>
538
+ <li>
539
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
540
+ </li>
541
+ </ul>
542
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
543
+ <p>a new address object</p>
544
+ </li>
545
+ </ul>
546
+ </section>
547
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
548
+ <a name="frommnemonic" class="tsd-anchor"></a>
549
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Mnemonic</h3>
550
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
551
+ <li class="tsd-signature tsd-kind-icon">from<wbr>Mnemonic<span class="tsd-signature-symbol">(</span>mnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
552
+ </ul>
553
+ <ul class="tsd-descriptions">
554
+ <li class="tsd-description">
555
+ <aside class="tsd-sources">
556
+ <ul>
557
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L277">Address.ts:277</a></li>
558
+ </ul>
559
+ </aside>
560
+ <div class="tsd-comment tsd-typography">
561
+ <div class="lead">
562
+ <p>Creates a new address object from a mnemonic phrase</p>
563
+ </div>
564
+ </div>
565
+ <h4 class="tsd-parameters-title">Parameters</h4>
566
+ <ul class="tsd-parameters">
567
+ <li>
568
+ <h5>mnemonic: <span class="tsd-signature-type">string</span></h5>
569
+ <div class="tsd-comment tsd-typography">
570
+ <p>the wallet mnemonic phrase</p>
571
+ </div>
572
+ </li>
573
+ <li>
574
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> language: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
575
+ </li>
576
+ <li>
577
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
578
+ </li>
579
+ </ul>
580
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
581
+ <p>a new address object</p>
582
+ </li>
583
+ </ul>
584
+ </section>
585
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
586
+ <a name="frompublickeys" class="tsd-anchor"></a>
587
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Public<wbr>Keys</h3>
588
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
589
+ <li class="tsd-signature tsd-kind-icon">from<wbr>Public<wbr>Keys<span class="tsd-signature-symbol">(</span>publicSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicViewKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
590
+ </ul>
591
+ <ul class="tsd-descriptions">
592
+ <li class="tsd-description">
593
+ <aside class="tsd-sources">
594
+ <ul>
595
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L173">Address.ts:173</a></li>
596
+ </ul>
597
+ </aside>
598
+ <div class="tsd-comment tsd-typography">
599
+ <div class="lead">
600
+ <p>Creates a new address object using the supplied public keys</p>
601
+ </div>
602
+ </div>
603
+ <h4 class="tsd-parameters-title">Parameters</h4>
604
+ <ul class="tsd-parameters">
605
+ <li>
606
+ <h5>publicSpendKey: <span class="tsd-signature-type">string</span></h5>
607
+ <div class="tsd-comment tsd-typography">
608
+ <p>the public spend key</p>
609
+ </div>
610
+ </li>
611
+ <li>
612
+ <h5>publicViewKey: <span class="tsd-signature-type">string</span></h5>
613
+ <div class="tsd-comment tsd-typography">
614
+ <p>the public view key</p>
615
+ </div>
616
+ </li>
617
+ <li>
618
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> paymentId: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
619
+ </li>
620
+ <li>
621
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
622
+ </li>
623
+ </ul>
624
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
625
+ <p>a new address object</p>
626
+ </li>
627
+ </ul>
628
+ </section>
629
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
630
+ <a name="fromseed" class="tsd-anchor"></a>
631
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Seed</h3>
632
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
633
+ <li class="tsd-signature tsd-kind-icon">from<wbr>Seed<span class="tsd-signature-symbol">(</span>seed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
634
+ </ul>
635
+ <ul class="tsd-descriptions">
636
+ <li class="tsd-description">
637
+ <aside class="tsd-sources">
638
+ <ul>
639
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L290">Address.ts:290</a></li>
640
+ </ul>
641
+ </aside>
642
+ <div class="tsd-comment tsd-typography">
643
+ <div class="lead">
644
+ <p>Creates a new address object from a seed</p>
645
+ </div>
646
+ </div>
647
+ <h4 class="tsd-parameters-title">Parameters</h4>
648
+ <ul class="tsd-parameters">
649
+ <li>
650
+ <h5>seed: <span class="tsd-signature-type">string</span></h5>
651
+ <div class="tsd-comment tsd-typography">
652
+ <p>the wallet seed</p>
653
+ </div>
654
+ </li>
655
+ <li>
656
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> language: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
657
+ </li>
658
+ <li>
659
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
660
+ </li>
661
+ </ul>
662
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
663
+ <p>a new address object</p>
664
+ </li>
665
+ </ul>
666
+ </section>
667
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
668
+ <a name="fromviewonlykeys" class="tsd-anchor"></a>
669
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>View<wbr>Only<wbr>Keys</h3>
670
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
671
+ <li class="tsd-signature tsd-kind-icon">from<wbr>View<wbr>Only<wbr>Keys<span class="tsd-signature-symbol">(</span>publicSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateViewKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, paymentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
672
+ </ul>
673
+ <ul class="tsd-descriptions">
674
+ <li class="tsd-description">
675
+ <aside class="tsd-sources">
676
+ <ul>
677
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L208">Address.ts:208</a></li>
678
+ </ul>
679
+ </aside>
680
+ <div class="tsd-comment tsd-typography">
681
+ <div class="lead">
682
+ <p>Creates a new address object (view only) using the supplied keys</p>
683
+ </div>
684
+ </div>
685
+ <h4 class="tsd-parameters-title">Parameters</h4>
686
+ <ul class="tsd-parameters">
687
+ <li>
688
+ <h5>publicSpendKey: <span class="tsd-signature-type">string</span></h5>
689
+ <div class="tsd-comment tsd-typography">
690
+ <p>the public spend key</p>
691
+ </div>
692
+ </li>
693
+ <li>
694
+ <h5>privateViewKey: <span class="tsd-signature-type">string</span></h5>
695
+ <div class="tsd-comment tsd-typography">
696
+ <p>the private view key</p>
697
+ </div>
698
+ </li>
699
+ <li>
700
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> paymentId: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
701
+ </li>
702
+ <li>
703
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
704
+ </li>
705
+ </ul>
706
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
707
+ <p>a new address object</p>
708
+ </li>
709
+ </ul>
710
+ </section>
711
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
712
+ <a name="generateseed" class="tsd-anchor"></a>
713
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> generate<wbr>Seed</h3>
714
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
715
+ <li class="tsd-signature tsd-kind-icon">generate<wbr>Seed<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, iterations<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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>
716
+ </ul>
717
+ <ul class="tsd-descriptions">
718
+ <li class="tsd-description">
719
+ <aside class="tsd-sources">
720
+ <ul>
721
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L335">Address.ts:335</a></li>
722
+ </ul>
723
+ </aside>
724
+ <div class="tsd-comment tsd-typography">
725
+ <div class="lead">
726
+ <p>Generates a new seed from entropy</p>
727
+ </div>
728
+ </div>
729
+ <h4 class="tsd-parameters-title">Parameters</h4>
730
+ <ul class="tsd-parameters">
731
+ <li>
732
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> entropy: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
733
+ </li>
734
+ <li>
735
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> iterations: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
736
+ </li>
737
+ </ul>
738
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
739
+ <p>a new randomly created seed</p>
740
+ </li>
741
+ </ul>
742
+ </section>
743
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
744
+ <a name="generatesubwallet" class="tsd-anchor"></a>
745
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> generate<wbr>Subwallet</h3>
746
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
747
+ <li class="tsd-signature tsd-kind-icon">generate<wbr>Subwallet<span class="tsd-signature-symbol">(</span>privateSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, subwalletIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">?: </span><a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><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><a href="address.html" class="tsd-signature-type">Address</a></li>
748
+ </ul>
749
+ <ul class="tsd-descriptions">
750
+ <li class="tsd-description">
751
+ <aside class="tsd-sources">
752
+ <ul>
753
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/Address.ts#L349">Address.ts:349</a></li>
754
+ </ul>
755
+ </aside>
756
+ <div class="tsd-comment tsd-typography">
757
+ <div class="lead">
758
+ <p>Generates a new subwallet address object using the supplied parameters</p>
759
+ </div>
760
+ </div>
761
+ <h4 class="tsd-parameters-title">Parameters</h4>
762
+ <ul class="tsd-parameters">
763
+ <li>
764
+ <h5>privateSpendKey: <span class="tsd-signature-type">string</span></h5>
765
+ <div class="tsd-comment tsd-typography">
766
+ <p>the private spend key</p>
767
+ </div>
768
+ </li>
769
+ <li>
770
+ <h5>subwalletIndex: <span class="tsd-signature-type">number</span></h5>
771
+ <div class="tsd-comment tsd-typography">
772
+ <p>the subwallet index number</p>
773
+ </div>
774
+ </li>
775
+ <li>
776
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> language: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
777
+ </li>
778
+ <li>
779
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <a href="addressprefix.html" class="tsd-signature-type">AddressPrefix</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
780
+ </li>
781
+ </ul>
782
+ <h4 class="tsd-returns-title">Returns <a href="address.html" class="tsd-signature-type">Address</a></h4>
783
+ <p>a new address object</p>
784
+ </li>
785
+ </ul>
786
+ </section>
787
+ </section>
788
+ </div>
789
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
790
+ <nav class="tsd-navigation primary">
791
+ <ul>
792
+ <li class="globals ">
793
+ <a href="../globals.html"><em>Globals</em></a>
794
+ </li>
795
+ </ul>
796
+ </nav>
797
+ <nav class="tsd-navigation secondary menu-sticky">
798
+ <ul class="before-current">
799
+ </ul>
800
+ <ul class="current">
801
+ <li class="current tsd-kind-class">
802
+ <a href="address.html" class="tsd-kind-icon">Address</a>
803
+ <ul>
804
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
805
+ <a href="address.html#address-1" class="tsd-kind-icon">address</a>
806
+ </li>
807
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
808
+ <a href="address.html#mnemonic" class="tsd-kind-icon">mnemonic</a>
809
+ </li>
810
+ <li class=" tsd-kind-accessor tsd-parent-kind-class">
811
+ <a href="address.html#paymentid" class="tsd-kind-icon">payment<wbr>Id</a>
812
+ </li>
813
+ <li class=" tsd-kind-accessor tsd-parent-kind-class">
814
+ <a href="address.html#prefix" class="tsd-kind-icon">prefix</a>
815
+ </li>
816
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
817
+ <a href="address.html#seed" class="tsd-kind-icon">seed</a>
818
+ </li>
819
+ <li class=" tsd-kind-accessor tsd-parent-kind-class">
820
+ <a href="address.html#spend" class="tsd-kind-icon">spend</a>
821
+ </li>
822
+ <li class=" tsd-kind-get-signature tsd-parent-kind-class">
823
+ <a href="address.html#subwalletindex" class="tsd-kind-icon">subwallet<wbr>Index</a>
824
+ </li>
825
+ <li class=" tsd-kind-accessor tsd-parent-kind-class">
826
+ <a href="address.html#view" class="tsd-kind-icon">view</a>
827
+ </li>
828
+ <li class=" tsd-kind-method tsd-parent-kind-class">
829
+ <a href="address.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
830
+ </li>
831
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
832
+ <a href="address.html#encoderaw" class="tsd-kind-icon">encode<wbr>Raw</a>
833
+ </li>
834
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
835
+ <a href="address.html#fromaddress" class="tsd-kind-icon">from<wbr>Address</a>
836
+ </li>
837
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
838
+ <a href="address.html#fromentropy" class="tsd-kind-icon">from<wbr>Entropy</a>
839
+ </li>
840
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
841
+ <a href="address.html#fromkeys" class="tsd-kind-icon">from<wbr>Keys</a>
842
+ </li>
843
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
844
+ <a href="address.html#frommnemonic" class="tsd-kind-icon">from<wbr>Mnemonic</a>
845
+ </li>
846
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
847
+ <a href="address.html#frompublickeys" class="tsd-kind-icon">from<wbr>Public<wbr>Keys</a>
848
+ </li>
849
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
850
+ <a href="address.html#fromseed" class="tsd-kind-icon">from<wbr>Seed</a>
851
+ </li>
852
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
853
+ <a href="address.html#fromviewonlykeys" class="tsd-kind-icon">from<wbr>View<wbr>Only<wbr>Keys</a>
854
+ </li>
855
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
856
+ <a href="address.html#generateseed" class="tsd-kind-icon">generate<wbr>Seed</a>
857
+ </li>
858
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
859
+ <a href="address.html#generatesubwallet" class="tsd-kind-icon">generate<wbr>Subwallet</a>
860
+ </li>
861
+ </ul>
862
+ </li>
863
+ </ul>
864
+ <ul class="after-current">
865
+ <li class=" tsd-kind-class">
866
+ <a href="addressprefix.html" class="tsd-kind-icon">Address<wbr>Prefix</a>
867
+ </li>
868
+ <li class=" tsd-kind-class">
869
+ <a href="block.html" class="tsd-kind-icon">Block</a>
870
+ </li>
871
+ <li class=" tsd-kind-class">
872
+ <a href="blocktemplate.html" class="tsd-kind-icon">Block<wbr>Template</a>
873
+ </li>
874
+ <li class=" tsd-kind-class">
875
+ <a href="cryptonote.html" class="tsd-kind-icon">Crypto<wbr>Note</a>
876
+ </li>
877
+ <li class=" tsd-kind-class">
878
+ <a href="levinpacket.html" class="tsd-kind-icon">Levin<wbr>Packet</a>
879
+ </li>
880
+ <li class=" tsd-kind-class">
881
+ <a href="multisig.html" class="tsd-kind-icon">Multisig</a>
882
+ </li>
883
+ <li class=" tsd-kind-class">
884
+ <a href="multisigmessage.html" class="tsd-kind-icon">Multisig<wbr>Message</a>
885
+ </li>
886
+ <li class=" tsd-kind-class">
887
+ <a href="parentblock.html" class="tsd-kind-icon">Parent<wbr>Block</a>
888
+ </li>
889
+ <li class=" tsd-kind-class">
890
+ <a href="transaction.html" class="tsd-kind-icon">Transaction</a>
891
+ </li>
892
+ </ul>
893
+ </nav>
894
+ </div>
895
+ </div>
896
+ </div>
897
+ <footer class="with-border-bottom">
898
+ <div class="container">
899
+ <h2>Legend</h2>
900
+ <div class="tsd-legend-group">
901
+ <ul class="tsd-legend">
902
+ <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
903
+ <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
904
+ <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
905
+ <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
906
+ <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
907
+ <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
908
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
909
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
910
+ </ul>
911
+ <ul class="tsd-legend">
912
+ <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
913
+ <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
914
+ <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
915
+ <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
916
+ </ul>
917
+ <ul class="tsd-legend">
918
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
919
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
920
+ <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
921
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
922
+ <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
923
+ <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
924
+ </ul>
925
+ <ul class="tsd-legend">
926
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
927
+ <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
928
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
929
+ <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
930
+ <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
931
+ <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
932
+ <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
933
+ </ul>
934
+ <ul class="tsd-legend">
935
+ <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
936
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
937
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
938
+ <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
939
+ </ul>
940
+ <ul class="tsd-legend">
941
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
942
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
943
+ <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
944
+ </ul>
945
+ <ul class="tsd-legend">
946
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
947
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
948
+ <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
949
+ </ul>
950
+ <ul class="tsd-legend">
951
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
952
+ <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
953
+ </ul>
954
+ </div>
955
+ </div>
956
+ </footer>
957
+ <div class="container tsd-generator">
958
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
959
+ </div>
960
+ <div class="overlay"></div>
961
+ <script src="../assets/js/main.js"></script>
962
+ <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
963
+ </body>
964
+ </html>