@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/cryptonote.html ADDED
@@ -0,0 +1,1137 @@
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>CryptoNote | 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="cryptonote.html">CryptoNote</a>
56
+ </li>
57
+ </ul>
58
+ <h1>Class CryptoNote</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>CryptoNote helper class for constructing transactions and performing
69
+ various other cryptographic items during the receipt or transfer
70
+ of funds on the network</p>
71
+ </div>
72
+ </div>
73
+ </section>
74
+ <section class="tsd-panel tsd-hierarchy">
75
+ <h3>Hierarchy</h3>
76
+ <ul class="tsd-hierarchy">
77
+ <li>
78
+ <span class="target">CryptoNote</span>
79
+ </li>
80
+ </ul>
81
+ </section>
82
+ <section class="tsd-panel-group tsd-index-group">
83
+ <h2>Index</h2>
84
+ <section class="tsd-panel tsd-index-panel">
85
+ <div class="tsd-index-content">
86
+ <section class="tsd-index-section ">
87
+ <h3>Constructors</h3>
88
+ <ul class="tsd-index-list">
89
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="cryptonote.html#constructor" class="tsd-kind-icon">constructor</a></li>
90
+ </ul>
91
+ </section>
92
+ <section class="tsd-index-section ">
93
+ <h3>Methods</h3>
94
+ <ul class="tsd-index-list">
95
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#absolutetorelativeoffsets" class="tsd-kind-icon">absolute<wbr>ToRelative<wbr>Offsets</a></li>
96
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#calculateminimumtransactionfee" class="tsd-kind-icon">calculate<wbr>Minimum<wbr>Transaction<wbr>Fee</a></li>
97
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#completetransaction" class="tsd-kind-icon">complete<wbr>Transaction</a></li>
98
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#createintegratedaddress" class="tsd-kind-icon">create<wbr>Integrated<wbr>Address</a></li>
99
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#createtransaction" class="tsd-kind-icon">create<wbr>Transaction</a></li>
100
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#createtransactionstructure" class="tsd-kind-icon">create<wbr>Transaction<wbr>Structure</a></li>
101
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#formatmoney" class="tsd-kind-icon">format<wbr>Money</a></li>
102
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#generatekeyimage" class="tsd-kind-icon">generate<wbr>Key<wbr>Image</a></li>
103
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#generatekeyimageprimitive" class="tsd-kind-icon">generate<wbr>Key<wbr>Image<wbr>Primitive</a></li>
104
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#generatetransactionoutputs" class="tsd-kind-icon">generate<wbr>Transaction<wbr>Outputs</a></li>
105
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#isourtransactionoutput" class="tsd-kind-icon">is<wbr>Our<wbr>Transaction<wbr>Output</a></li>
106
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#preparetransaction" class="tsd-kind-icon">prepare<wbr>Transaction</a></li>
107
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#privatekeytopublickey" class="tsd-kind-icon">private<wbr>Key<wbr>ToPublic<wbr>Key</a></li>
108
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#relativetoabsoluteoffsets" class="tsd-kind-icon">relative<wbr>ToAbsolute<wbr>Offsets</a></li>
109
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#scantransactionoutputs" class="tsd-kind-icon">scan<wbr>Transaction<wbr>Outputs</a></li>
110
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#signmessage" class="tsd-kind-icon">sign<wbr>Message</a></li>
111
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="cryptonote.html#verifymessagesignature" class="tsd-kind-icon">verify<wbr>Message<wbr>Signature</a></li>
112
+ </ul>
113
+ </section>
114
+ </div>
115
+ </section>
116
+ </section>
117
+ <section class="tsd-panel-group tsd-member-group ">
118
+ <h2>Constructors</h2>
119
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
120
+ <a name="constructor" class="tsd-anchor"></a>
121
+ <h3>constructor</h3>
122
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
123
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Crypto<wbr>Note<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><a href="../interfaces/interfaces.config.html" class="tsd-signature-type">Config</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="cryptonote.html" class="tsd-signature-type">CryptoNote</a></li>
124
+ </ul>
125
+ <ul class="tsd-descriptions">
126
+ <li class="tsd-description">
127
+ <aside class="tsd-sources">
128
+ <ul>
129
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L27">CryptoNote.ts:27</a></li>
130
+ </ul>
131
+ </aside>
132
+ <div class="tsd-comment tsd-typography">
133
+ <div class="lead">
134
+ <p>Constructs a new instance of the object
135
+ If a configuration is supplied, it is also passed to the underlying
136
+ cryptographic library</p>
137
+ </div>
138
+ </div>
139
+ <h4 class="tsd-parameters-title">Parameters</h4>
140
+ <ul class="tsd-parameters">
141
+ <li>
142
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <a href="../interfaces/interfaces.config.html" class="tsd-signature-type">Config</a></h5>
143
+ </li>
144
+ </ul>
145
+ <h4 class="tsd-returns-title">Returns <a href="cryptonote.html" class="tsd-signature-type">CryptoNote</a></h4>
146
+ </li>
147
+ </ul>
148
+ </section>
149
+ </section>
150
+ <section class="tsd-panel-group tsd-member-group ">
151
+ <h2>Methods</h2>
152
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
153
+ <a name="absolutetorelativeoffsets" class="tsd-anchor"></a>
154
+ <h3>absolute<wbr>ToRelative<wbr>Offsets</h3>
155
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
156
+ <li class="tsd-signature tsd-kind-icon">absolute<wbr>ToRelative<wbr>Offsets<span class="tsd-signature-symbol">(</span>offsets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger.BigInteger</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-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-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></li>
157
+ </ul>
158
+ <ul class="tsd-descriptions">
159
+ <li class="tsd-description">
160
+ <aside class="tsd-sources">
161
+ <ul>
162
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L90">CryptoNote.ts:90</a></li>
163
+ </ul>
164
+ </aside>
165
+ <div class="tsd-comment tsd-typography">
166
+ <div class="lead">
167
+ <p>Converts absolute global index offsets to relative ones</p>
168
+ </div>
169
+ </div>
170
+ <h4 class="tsd-parameters-title">Parameters</h4>
171
+ <ul class="tsd-parameters">
172
+ <li>
173
+ <h5>offsets: <span class="tsd-signature-type">BigInteger.BigInteger</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-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
174
+ <div class="tsd-comment tsd-typography">
175
+ <p>the absolute offsets</p>
176
+ </div>
177
+ </li>
178
+ </ul>
179
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4>
180
+ <p>the relative offsets</p>
181
+ </li>
182
+ </ul>
183
+ </section>
184
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
185
+ <a name="calculateminimumtransactionfee" class="tsd-anchor"></a>
186
+ <h3>calculate<wbr>Minimum<wbr>Transaction<wbr>Fee</h3>
187
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
188
+ <li class="tsd-signature tsd-kind-icon">calculate<wbr>Minimum<wbr>Transaction<wbr>Fee<span class="tsd-signature-symbol">(</span>txSize<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">number</span></li>
189
+ </ul>
190
+ <ul class="tsd-descriptions">
191
+ <li class="tsd-description">
192
+ <aside class="tsd-sources">
193
+ <ul>
194
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L284">CryptoNote.ts:284</a></li>
195
+ </ul>
196
+ </aside>
197
+ <div class="tsd-comment tsd-typography">
198
+ <div class="lead">
199
+ <p>Calculates the minimum transaction fee given the transaction size (bytes)</p>
200
+ </div>
201
+ </div>
202
+ <h4 class="tsd-parameters-title">Parameters</h4>
203
+ <ul class="tsd-parameters">
204
+ <li>
205
+ <h5>txSize: <span class="tsd-signature-type">number</span></h5>
206
+ <div class="tsd-comment tsd-typography">
207
+ <p>the transaction size in bytes</p>
208
+ </div>
209
+ </li>
210
+ </ul>
211
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
212
+ <p>the minimum transaction fee</p>
213
+ </li>
214
+ </ul>
215
+ </section>
216
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
217
+ <a name="completetransaction" class="tsd-anchor"></a>
218
+ <h3>complete<wbr>Transaction</h3>
219
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
220
+ <li class="tsd-signature tsd-kind-icon">complete<wbr>Transaction<span class="tsd-signature-symbol">(</span>preparedTransaction<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.preparedtransaction.html" class="tsd-signature-type">PreparedTransaction</a>, privateSpendKey<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="transaction.html" class="tsd-signature-type">Transaction</a><span class="tsd-signature-symbol">&gt;</span></li>
221
+ </ul>
222
+ <ul class="tsd-descriptions">
223
+ <li class="tsd-description">
224
+ <aside class="tsd-sources">
225
+ <ul>
226
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L791">CryptoNote.ts:791</a></li>
227
+ </ul>
228
+ </aside>
229
+ <div class="tsd-comment tsd-typography">
230
+ <div class="lead">
231
+ <p>Completes a prepared transaction using the supplied private ephemeral
232
+ The resulting transaction can be broadcast to the network. Please note that the PreparedTransaction
233
+ signatures meta data must be updated to include the proper private ephemeral</p>
234
+ </div>
235
+ </div>
236
+ <h4 class="tsd-parameters-title">Parameters</h4>
237
+ <ul class="tsd-parameters">
238
+ <li>
239
+ <h5>preparedTransaction: <a href="../interfaces/interfaces.preparedtransaction.html" class="tsd-signature-type">PreparedTransaction</a></h5>
240
+ <div class="tsd-comment tsd-typography">
241
+ <p>the prepared transaction</p>
242
+ </div>
243
+ </li>
244
+ <li>
245
+ <h5>privateSpendKey: <span class="tsd-signature-type">string</span></h5>
246
+ <div class="tsd-comment tsd-typography">
247
+ <p>the private spend key of the wallet that contains the funds</p>
248
+ </div>
249
+ </li>
250
+ </ul>
251
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="transaction.html" class="tsd-signature-type">Transaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
252
+ <p>the completed transaction</p>
253
+ </li>
254
+ </ul>
255
+ </section>
256
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
257
+ <a name="createintegratedaddress" class="tsd-anchor"></a>
258
+ <h3>create<wbr>Integrated<wbr>Address</h3>
259
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
260
+ <li class="tsd-signature tsd-kind-icon">create<wbr>Integrated<wbr>Address<span class="tsd-signature-symbol">(</span>address<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">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><span class="tsd-signature-type">string</span></li>
261
+ </ul>
262
+ <ul class="tsd-descriptions">
263
+ <li class="tsd-description">
264
+ <aside class="tsd-sources">
265
+ <ul>
266
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L301">CryptoNote.ts:301</a></li>
267
+ </ul>
268
+ </aside>
269
+ <div class="tsd-comment tsd-typography">
270
+ <div class="lead">
271
+ <p>Creates an integrated address using the supplied values</p>
272
+ </div>
273
+ </div>
274
+ <h4 class="tsd-parameters-title">Parameters</h4>
275
+ <ul class="tsd-parameters">
276
+ <li>
277
+ <h5>address: <span class="tsd-signature-type">string</span></h5>
278
+ <div class="tsd-comment tsd-typography">
279
+ <p>the wallet address</p>
280
+ </div>
281
+ </li>
282
+ <li>
283
+ <h5>paymentId: <span class="tsd-signature-type">string</span></h5>
284
+ <div class="tsd-comment tsd-typography">
285
+ <p>the payment ID</p>
286
+ </div>
287
+ </li>
288
+ <li>
289
+ <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>
290
+ </li>
291
+ </ul>
292
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
293
+ <p>the integrated address</p>
294
+ </li>
295
+ </ul>
296
+ </section>
297
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
298
+ <a name="createtransaction" class="tsd-anchor"></a>
299
+ <h3>create<wbr>Transaction</h3>
300
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
301
+ <li class="tsd-signature tsd-kind-icon">create<wbr>Transaction<span class="tsd-signature-symbol">(</span>outputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span>, inputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span>, randomOutputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.randomoutput.html" class="tsd-signature-type">RandomOutput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span>, mixin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, feeAmount<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>, 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>, unlockTime<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>, extraData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="transaction.html" class="tsd-signature-type">Transaction</a><span class="tsd-signature-symbol">&gt;</span></li>
302
+ </ul>
303
+ <ul class="tsd-descriptions">
304
+ <li class="tsd-description">
305
+ <aside class="tsd-sources">
306
+ <ul>
307
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L443">CryptoNote.ts:443</a></li>
308
+ </ul>
309
+ </aside>
310
+ <div class="tsd-comment tsd-typography">
311
+ <div class="lead">
312
+ <p>Constructs a new Transaction using the supplied values.
313
+ The resulting transaction can be broadcasted to the TurtleCoin network</p>
314
+ </div>
315
+ <dl class="tsd-comment-tags">
316
+ <dt>async</dt>
317
+ <dd></dd>
318
+ </dl>
319
+ </div>
320
+ <h4 class="tsd-parameters-title">Parameters</h4>
321
+ <ul class="tsd-parameters">
322
+ <li>
323
+ <h5>outputs: <a href="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span></h5>
324
+ <div class="tsd-comment tsd-typography">
325
+ <p>the new outputs for the transaction (TO)</p>
326
+ </div>
327
+ </li>
328
+ <li>
329
+ <h5>inputs: <a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span></h5>
330
+ <div class="tsd-comment tsd-typography">
331
+ <p>outputs we will be spending (FROM)</p>
332
+ </div>
333
+ </li>
334
+ <li>
335
+ <h5>randomOutputs: <a href="../interfaces/interfaces.randomoutput.html" class="tsd-signature-type">RandomOutput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h5>
336
+ <div class="tsd-comment tsd-typography">
337
+ <p>the random outputs to use for mixing</p>
338
+ </div>
339
+ </li>
340
+ <li>
341
+ <h5>mixin: <span class="tsd-signature-type">number</span></h5>
342
+ <div class="tsd-comment tsd-typography">
343
+ <p>the number of mixins to use</p>
344
+ </div>
345
+ </li>
346
+ <li>
347
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> feeAmount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
348
+ </li>
349
+ <li>
350
+ <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>
351
+ </li>
352
+ <li>
353
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> unlockTime: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
354
+ </li>
355
+ <li>
356
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> extraData: <span class="tsd-signature-type">any</span></h5>
357
+ </li>
358
+ </ul>
359
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="transaction.html" class="tsd-signature-type">Transaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
360
+ <p>the newly created transaction object</p>
361
+ </li>
362
+ </ul>
363
+ </section>
364
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
365
+ <a name="createtransactionstructure" class="tsd-anchor"></a>
366
+ <h3>create<wbr>Transaction<wbr>Structure</h3>
367
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
368
+ <li class="tsd-signature tsd-kind-icon">create<wbr>Transaction<wbr>Structure<span class="tsd-signature-symbol">(</span>outputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span>, inputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span>, randomOutputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.randomoutput.html" class="tsd-signature-type">RandomOutput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span>, mixin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, feeAmount<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>, 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>, unlockTime<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>, extraData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.ipreparedtransaction.html" class="tsd-signature-type">IPreparedTransaction</a><span class="tsd-signature-symbol">&gt;</span></li>
369
+ </ul>
370
+ <ul class="tsd-descriptions">
371
+ <li class="tsd-description">
372
+ <aside class="tsd-sources">
373
+ <ul>
374
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L522">CryptoNote.ts:522</a></li>
375
+ </ul>
376
+ </aside>
377
+ <div class="tsd-comment tsd-typography">
378
+ <div class="lead">
379
+ <p>Constructs a new Transaction using the supplied values.
380
+ Note: Does not sign the transaction</p>
381
+ </div>
382
+ <dl class="tsd-comment-tags">
383
+ <dt>async</dt>
384
+ <dd></dd>
385
+ </dl>
386
+ </div>
387
+ <h4 class="tsd-parameters-title">Parameters</h4>
388
+ <ul class="tsd-parameters">
389
+ <li>
390
+ <h5>outputs: <a href="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span></h5>
391
+ <div class="tsd-comment tsd-typography">
392
+ <p>the new outputs for the transaction (TO)</p>
393
+ </div>
394
+ </li>
395
+ <li>
396
+ <h5>inputs: <a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span></h5>
397
+ <div class="tsd-comment tsd-typography">
398
+ <p>outputs we will be spending (FROM)</p>
399
+ </div>
400
+ </li>
401
+ <li>
402
+ <h5>randomOutputs: <a href="../interfaces/interfaces.randomoutput.html" class="tsd-signature-type">RandomOutput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h5>
403
+ <div class="tsd-comment tsd-typography">
404
+ <p>the random outputs to use for mixing</p>
405
+ </div>
406
+ </li>
407
+ <li>
408
+ <h5>mixin: <span class="tsd-signature-type">number</span></h5>
409
+ <div class="tsd-comment tsd-typography">
410
+ <p>the number of mixins to use</p>
411
+ </div>
412
+ </li>
413
+ <li>
414
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> feeAmount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
415
+ </li>
416
+ <li>
417
+ <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>
418
+ </li>
419
+ <li>
420
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> unlockTime: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
421
+ </li>
422
+ <li>
423
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> extraData: <span class="tsd-signature-type">any</span></h5>
424
+ </li>
425
+ </ul>
426
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.ipreparedtransaction.html" class="tsd-signature-type">IPreparedTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
427
+ <p>the newly created transaction object and it&#39;s input data</p>
428
+ </li>
429
+ </ul>
430
+ </section>
431
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
432
+ <a name="formatmoney" class="tsd-anchor"></a>
433
+ <h3>format<wbr>Money</h3>
434
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
435
+ <li class="tsd-signature tsd-kind-icon">format<wbr>Money<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger.BigInteger</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>
436
+ </ul>
437
+ <ul class="tsd-descriptions">
438
+ <li class="tsd-description">
439
+ <aside class="tsd-sources">
440
+ <ul>
441
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L326">CryptoNote.ts:326</a></li>
442
+ </ul>
443
+ </aside>
444
+ <div class="tsd-comment tsd-typography">
445
+ <div class="lead">
446
+ <p>Formats atomic units into human readable units</p>
447
+ </div>
448
+ </div>
449
+ <h4 class="tsd-parameters-title">Parameters</h4>
450
+ <ul class="tsd-parameters">
451
+ <li>
452
+ <h5>amount: <span class="tsd-signature-type">BigInteger.BigInteger</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
453
+ <div class="tsd-comment tsd-typography">
454
+ <p>the amount in atomic units</p>
455
+ </div>
456
+ </li>
457
+ </ul>
458
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
459
+ <p>the amount in human readable units</p>
460
+ </li>
461
+ </ul>
462
+ </section>
463
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
464
+ <a name="generatekeyimage" class="tsd-anchor"></a>
465
+ <h3>generate<wbr>Key<wbr>Image</h3>
466
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
467
+ <li class="tsd-signature tsd-kind-icon">generate<wbr>Key<wbr>Image<span class="tsd-signature-symbol">(</span>transactionPublicKey<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>, publicSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, outputIndex<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
468
+ </ul>
469
+ <ul class="tsd-descriptions">
470
+ <li class="tsd-description">
471
+ <aside class="tsd-sources">
472
+ <ul>
473
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L125">CryptoNote.ts:125</a></li>
474
+ </ul>
475
+ </aside>
476
+ <div class="tsd-comment tsd-typography">
477
+ <div class="lead">
478
+ <p>Generates a key image from the supplied values</p>
479
+ </div>
480
+ <dl class="tsd-comment-tags">
481
+ <dt>async</dt>
482
+ <dd></dd>
483
+ </dl>
484
+ </div>
485
+ <h4 class="tsd-parameters-title">Parameters</h4>
486
+ <ul class="tsd-parameters">
487
+ <li>
488
+ <h5>transactionPublicKey: <span class="tsd-signature-type">string</span></h5>
489
+ <div class="tsd-comment tsd-typography">
490
+ <p>the transaction public key</p>
491
+ </div>
492
+ </li>
493
+ <li>
494
+ <h5>privateViewKey: <span class="tsd-signature-type">string</span></h5>
495
+ <div class="tsd-comment tsd-typography">
496
+ <p>the private view key</p>
497
+ </div>
498
+ </li>
499
+ <li>
500
+ <h5>publicSpendKey: <span class="tsd-signature-type">string</span></h5>
501
+ <div class="tsd-comment tsd-typography">
502
+ <p>the public spend key</p>
503
+ </div>
504
+ </li>
505
+ <li>
506
+ <h5>privateSpendKey: <span class="tsd-signature-type">string</span></h5>
507
+ <div class="tsd-comment tsd-typography">
508
+ <p>the private spend key</p>
509
+ </div>
510
+ </li>
511
+ <li>
512
+ <h5>outputIndex: <span class="tsd-signature-type">number</span></h5>
513
+ <div class="tsd-comment tsd-typography">
514
+ <p>the index of the output in the transaction</p>
515
+ </div>
516
+ </li>
517
+ </ul>
518
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
519
+ <p>the key image</p>
520
+ </li>
521
+ </ul>
522
+ </section>
523
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
524
+ <a name="generatekeyimageprimitive" class="tsd-anchor"></a>
525
+ <h3>generate<wbr>Key<wbr>Image<wbr>Primitive</h3>
526
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
527
+ <li class="tsd-signature tsd-kind-icon">generate<wbr>Key<wbr>Image<wbr>Primitive<span class="tsd-signature-symbol">(</span>publicSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, outputIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, derivation<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
528
+ </ul>
529
+ <ul class="tsd-descriptions">
530
+ <li class="tsd-description">
531
+ <aside class="tsd-sources">
532
+ <ul>
533
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L145">CryptoNote.ts:145</a></li>
534
+ </ul>
535
+ </aside>
536
+ <div class="tsd-comment tsd-typography">
537
+ <div class="lead">
538
+ <p>Primitive method for generating a key image from the supplied values</p>
539
+ </div>
540
+ <dl class="tsd-comment-tags">
541
+ <dt>async</dt>
542
+ <dd></dd>
543
+ </dl>
544
+ </div>
545
+ <h4 class="tsd-parameters-title">Parameters</h4>
546
+ <ul class="tsd-parameters">
547
+ <li>
548
+ <h5>publicSpendKey: <span class="tsd-signature-type">string</span></h5>
549
+ <div class="tsd-comment tsd-typography">
550
+ <p>the public spend key</p>
551
+ </div>
552
+ </li>
553
+ <li>
554
+ <h5>privateSpendKey: <span class="tsd-signature-type">string</span></h5>
555
+ <div class="tsd-comment tsd-typography">
556
+ <p>the private spend key</p>
557
+ </div>
558
+ </li>
559
+ <li>
560
+ <h5>outputIndex: <span class="tsd-signature-type">number</span></h5>
561
+ <div class="tsd-comment tsd-typography">
562
+ <p>the index of the output in the transaction</p>
563
+ </div>
564
+ </li>
565
+ <li>
566
+ <h5>derivation: <span class="tsd-signature-type">string</span></h5>
567
+ <div class="tsd-comment tsd-typography">
568
+ <p>the key derivation</p>
569
+ </div>
570
+ </li>
571
+ </ul>
572
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
573
+ <p>the key image</p>
574
+ </li>
575
+ </ul>
576
+ </section>
577
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
578
+ <a name="generatetransactionoutputs" class="tsd-anchor"></a>
579
+ <h3>generate<wbr>Transaction<wbr>Outputs</h3>
580
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
581
+ <li class="tsd-signature tsd-kind-icon">generate<wbr>Transaction<wbr>Outputs<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<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="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span></li>
582
+ </ul>
583
+ <ul class="tsd-descriptions">
584
+ <li class="tsd-description">
585
+ <aside class="tsd-sources">
586
+ <ul>
587
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L349">CryptoNote.ts:349</a></li>
588
+ </ul>
589
+ </aside>
590
+ <div class="tsd-comment tsd-typography">
591
+ <div class="lead">
592
+ <p>Generates an array of transaction outputs (new destinations) for the given address
593
+ and the given amount within the allowed rules of the network</p>
594
+ </div>
595
+ </div>
596
+ <h4 class="tsd-parameters-title">Parameters</h4>
597
+ <ul class="tsd-parameters">
598
+ <li>
599
+ <h5>address: <span class="tsd-signature-type">string</span></h5>
600
+ <div class="tsd-comment tsd-typography">
601
+ <p>the destination wallet address</p>
602
+ </div>
603
+ </li>
604
+ <li>
605
+ <h5>amount: <span class="tsd-signature-type">number</span></h5>
606
+ <div class="tsd-comment tsd-typography">
607
+ <p>the amount to send</p>
608
+ </div>
609
+ </li>
610
+ </ul>
611
+ <h4 class="tsd-returns-title">Returns <a href="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span></h4>
612
+ <p>a list of transaction outputs</p>
613
+ </li>
614
+ </ul>
615
+ </section>
616
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
617
+ <a name="isourtransactionoutput" class="tsd-anchor"></a>
618
+ <h3>is<wbr>Our<wbr>Transaction<wbr>Output</h3>
619
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
620
+ <li class="tsd-signature tsd-kind-icon">is<wbr>Our<wbr>Transaction<wbr>Output<span class="tsd-signature-symbol">(</span>transactionPublicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, output<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a>, privateViewKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateSpendKey<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>, generatePartial<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">&gt;</span></li>
621
+ </ul>
622
+ <ul class="tsd-descriptions">
623
+ <li class="tsd-description">
624
+ <aside class="tsd-sources">
625
+ <ul>
626
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L226">CryptoNote.ts:226</a></li>
627
+ </ul>
628
+ </aside>
629
+ <div class="tsd-comment tsd-typography">
630
+ <div class="lead">
631
+ <p>Scans the given transaction output to determine if it belongs to us, if so, we return the output
632
+ with the private ephemeral and key image if the privateSpendKey was supplied</p>
633
+ </div>
634
+ <dl class="tsd-comment-tags">
635
+ <dt>async</dt>
636
+ <dd></dd>
637
+ </dl>
638
+ </div>
639
+ <h4 class="tsd-parameters-title">Parameters</h4>
640
+ <ul class="tsd-parameters">
641
+ <li>
642
+ <h5>transactionPublicKey: <span class="tsd-signature-type">string</span></h5>
643
+ <div class="tsd-comment tsd-typography">
644
+ <p>the transaction public key</p>
645
+ </div>
646
+ </li>
647
+ <li>
648
+ <h5>output: <a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a></h5>
649
+ <div class="tsd-comment tsd-typography">
650
+ <p>the transaction output</p>
651
+ </div>
652
+ </li>
653
+ <li>
654
+ <h5>privateViewKey: <span class="tsd-signature-type">string</span></h5>
655
+ <div class="tsd-comment tsd-typography">
656
+ <p>the private view key</p>
657
+ </div>
658
+ </li>
659
+ <li>
660
+ <h5>publicSpendKey: <span class="tsd-signature-type">string</span></h5>
661
+ <div class="tsd-comment tsd-typography">
662
+ <p>the public spend key</p>
663
+ </div>
664
+ </li>
665
+ <li>
666
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> privateSpendKey: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
667
+ </li>
668
+ <li>
669
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> generatePartial: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
670
+ </li>
671
+ </ul>
672
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">&gt;</span></h4>
673
+ <p>the output if it belongs to us</p>
674
+ </li>
675
+ </ul>
676
+ </section>
677
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
678
+ <a name="preparetransaction" class="tsd-anchor"></a>
679
+ <h3>prepare<wbr>Transaction</h3>
680
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
681
+ <li class="tsd-signature tsd-kind-icon">prepare<wbr>Transaction<span class="tsd-signature-symbol">(</span>outputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span>, inputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span>, randomOutputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.randomoutput.html" class="tsd-signature-type">RandomOutput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span>, mixin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, feeAmount<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>, 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>, unlockTime<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>, extraData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.preparedtransaction.html" class="tsd-signature-type">PreparedTransaction</a><span class="tsd-signature-symbol">&gt;</span></li>
682
+ </ul>
683
+ <ul class="tsd-descriptions">
684
+ <li class="tsd-description">
685
+ <aside class="tsd-sources">
686
+ <ul>
687
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L688">CryptoNote.ts:688</a></li>
688
+ </ul>
689
+ </aside>
690
+ <div class="tsd-comment tsd-typography">
691
+ <div class="lead">
692
+ <p>Constructs a new Transaction using the supplied values.
693
+ The resulting transaction can be broadcasted to the TurtleCoin network</p>
694
+ </div>
695
+ <dl class="tsd-comment-tags">
696
+ <dt>async</dt>
697
+ <dd></dd>
698
+ </dl>
699
+ </div>
700
+ <h4 class="tsd-parameters-title">Parameters</h4>
701
+ <ul class="tsd-parameters">
702
+ <li>
703
+ <h5>outputs: <a href="../interfaces/interfaces.generatedoutput.html" class="tsd-signature-type">GeneratedOutput</a><span class="tsd-signature-symbol">[]</span></h5>
704
+ <div class="tsd-comment tsd-typography">
705
+ <p>the new outputs for the transaction (TO)</p>
706
+ </div>
707
+ </li>
708
+ <li>
709
+ <h5>inputs: <a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span></h5>
710
+ <div class="tsd-comment tsd-typography">
711
+ <p>outputs we will be spending (FROM)</p>
712
+ </div>
713
+ </li>
714
+ <li>
715
+ <h5>randomOutputs: <a href="../interfaces/interfaces.randomoutput.html" class="tsd-signature-type">RandomOutput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h5>
716
+ <div class="tsd-comment tsd-typography">
717
+ <p>the random outputs to use for mixing</p>
718
+ </div>
719
+ </li>
720
+ <li>
721
+ <h5>mixin: <span class="tsd-signature-type">number</span></h5>
722
+ <div class="tsd-comment tsd-typography">
723
+ <p>the number of mixins to use</p>
724
+ </div>
725
+ </li>
726
+ <li>
727
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> feeAmount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
728
+ </li>
729
+ <li>
730
+ <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>
731
+ </li>
732
+ <li>
733
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> unlockTime: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
734
+ </li>
735
+ <li>
736
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> extraData: <span class="tsd-signature-type">any</span></h5>
737
+ </li>
738
+ </ul>
739
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.preparedtransaction.html" class="tsd-signature-type">PreparedTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
740
+ <p>the newly created transaction object with prepared signatures</p>
741
+ </li>
742
+ </ul>
743
+ </section>
744
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
745
+ <a name="privatekeytopublickey" class="tsd-anchor"></a>
746
+ <h3>private<wbr>Key<wbr>ToPublic<wbr>Key</h3>
747
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
748
+ <li class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>ToPublic<wbr>Key<span class="tsd-signature-symbol">(</span>privateKey<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
749
+ </ul>
750
+ <ul class="tsd-descriptions">
751
+ <li class="tsd-description">
752
+ <aside class="tsd-sources">
753
+ <ul>
754
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L163">CryptoNote.ts:163</a></li>
755
+ </ul>
756
+ </aside>
757
+ <div class="tsd-comment tsd-typography">
758
+ <div class="lead">
759
+ <p>Provides the public key of the supplied private key</p>
760
+ </div>
761
+ <dl class="tsd-comment-tags">
762
+ <dt>async</dt>
763
+ <dd></dd>
764
+ </dl>
765
+ </div>
766
+ <h4 class="tsd-parameters-title">Parameters</h4>
767
+ <ul class="tsd-parameters">
768
+ <li>
769
+ <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
770
+ <div class="tsd-comment tsd-typography">
771
+ <p>the private key</p>
772
+ </div>
773
+ </li>
774
+ </ul>
775
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
776
+ <p>the public key</p>
777
+ </li>
778
+ </ul>
779
+ </section>
780
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
781
+ <a name="relativetoabsoluteoffsets" class="tsd-anchor"></a>
782
+ <h3>relative<wbr>ToAbsolute<wbr>Offsets</h3>
783
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
784
+ <li class="tsd-signature tsd-kind-icon">relative<wbr>ToAbsolute<wbr>Offsets<span class="tsd-signature-symbol">(</span>offsets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigInteger.BigInteger</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-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-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></li>
785
+ </ul>
786
+ <ul class="tsd-descriptions">
787
+ <li class="tsd-description">
788
+ <aside class="tsd-sources">
789
+ <ul>
790
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L105">CryptoNote.ts:105</a></li>
791
+ </ul>
792
+ </aside>
793
+ <div class="tsd-comment tsd-typography">
794
+ <div class="lead">
795
+ <p>Converts relative global index offsets to absolute offsets</p>
796
+ </div>
797
+ </div>
798
+ <h4 class="tsd-parameters-title">Parameters</h4>
799
+ <ul class="tsd-parameters">
800
+ <li>
801
+ <h5>offsets: <span class="tsd-signature-type">BigInteger.BigInteger</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-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
802
+ <div class="tsd-comment tsd-typography">
803
+ <p>the relative offsets</p>
804
+ </div>
805
+ </li>
806
+ </ul>
807
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4>
808
+ <p>the absolute offsets</p>
809
+ </li>
810
+ </ul>
811
+ </section>
812
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
813
+ <a name="scantransactionoutputs" class="tsd-anchor"></a>
814
+ <h3>scan<wbr>Transaction<wbr>Outputs</h3>
815
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
816
+ <li class="tsd-signature tsd-kind-icon">scan<wbr>Transaction<wbr>Outputs<span class="tsd-signature-symbol">(</span>transactionPublicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, outputs<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span>, privateViewKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, publicSpendKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateSpendKey<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>, generatePartial<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
817
+ </ul>
818
+ <ul class="tsd-descriptions">
819
+ <li class="tsd-description">
820
+ <aside class="tsd-sources">
821
+ <ul>
822
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L179">CryptoNote.ts:179</a></li>
823
+ </ul>
824
+ </aside>
825
+ <div class="tsd-comment tsd-typography">
826
+ <div class="lead">
827
+ <p>Scans the provided transaction outputs and returns those outputs which belong to us.
828
+ If the privateSpendKey is not supplied, the private ephemeral and key image will be undefined</p>
829
+ </div>
830
+ <dl class="tsd-comment-tags">
831
+ <dt>async</dt>
832
+ <dd></dd>
833
+ </dl>
834
+ </div>
835
+ <h4 class="tsd-parameters-title">Parameters</h4>
836
+ <ul class="tsd-parameters">
837
+ <li>
838
+ <h5>transactionPublicKey: <span class="tsd-signature-type">string</span></h5>
839
+ <div class="tsd-comment tsd-typography">
840
+ <p>the transaction public key</p>
841
+ </div>
842
+ </li>
843
+ <li>
844
+ <h5>outputs: <a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span></h5>
845
+ <div class="tsd-comment tsd-typography">
846
+ <p>the transaction outputs</p>
847
+ </div>
848
+ </li>
849
+ <li>
850
+ <h5>privateViewKey: <span class="tsd-signature-type">string</span></h5>
851
+ <div class="tsd-comment tsd-typography">
852
+ <p>the private view key</p>
853
+ </div>
854
+ </li>
855
+ <li>
856
+ <h5>publicSpendKey: <span class="tsd-signature-type">string</span></h5>
857
+ <div class="tsd-comment tsd-typography">
858
+ <p>the public spend key</p>
859
+ </div>
860
+ </li>
861
+ <li>
862
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> privateSpendKey: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
863
+ </li>
864
+ <li>
865
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> generatePartial: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
866
+ </li>
867
+ </ul>
868
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interfaces.output.html" class="tsd-signature-type">Output</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
869
+ <p>an list of outputs that belong to us</p>
870
+ </li>
871
+ </ul>
872
+ </section>
873
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
874
+ <a name="signmessage" class="tsd-anchor"></a>
875
+ <h3>sign<wbr>Message</h3>
876
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
877
+ <li class="tsd-signature tsd-kind-icon">sign<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, privateKey<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
878
+ </ul>
879
+ <ul class="tsd-descriptions">
880
+ <li class="tsd-description">
881
+ <aside class="tsd-sources">
882
+ <ul>
883
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L391">CryptoNote.ts:391</a></li>
884
+ </ul>
885
+ </aside>
886
+ <div class="tsd-comment tsd-typography">
887
+ <div class="lead">
888
+ <p>Signs an arbitrary message using the supplied private key</p>
889
+ </div>
890
+ <dl class="tsd-comment-tags">
891
+ <dt>async</dt>
892
+ <dd></dd>
893
+ </dl>
894
+ </div>
895
+ <h4 class="tsd-parameters-title">Parameters</h4>
896
+ <ul class="tsd-parameters">
897
+ <li>
898
+ <h5>message: <span class="tsd-signature-type">any</span></h5>
899
+ <div class="tsd-comment tsd-typography">
900
+ <p>the arbitrary message to sign</p>
901
+ </div>
902
+ </li>
903
+ <li>
904
+ <h5>privateKey: <span class="tsd-signature-type">string</span></h5>
905
+ <div class="tsd-comment tsd-typography">
906
+ <p>the private key to sign with</p>
907
+ </div>
908
+ </li>
909
+ </ul>
910
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
911
+ <p>the signature</p>
912
+ </li>
913
+ </ul>
914
+ </section>
915
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
916
+ <a name="verifymessagesignature" class="tsd-anchor"></a>
917
+ <h3>verify<wbr>Message<wbr>Signature</h3>
918
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
919
+ <li class="tsd-signature tsd-kind-icon">verify<wbr>Message<wbr>Signature<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, signature<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
920
+ </ul>
921
+ <ul class="tsd-descriptions">
922
+ <li class="tsd-description">
923
+ <aside class="tsd-sources">
924
+ <ul>
925
+ <li>Defined in <a href="https://github.com/turtlecoin/turtlecoin-utils/blob/847858e/src/CryptoNote.ts#L413">CryptoNote.ts:413</a></li>
926
+ </ul>
927
+ </aside>
928
+ <div class="tsd-comment tsd-typography">
929
+ <div class="lead">
930
+ <p>Verifies the signature of an arbitrary message using the signature and the supplied public key</p>
931
+ </div>
932
+ <dl class="tsd-comment-tags">
933
+ <dt>async</dt>
934
+ <dd></dd>
935
+ </dl>
936
+ </div>
937
+ <h4 class="tsd-parameters-title">Parameters</h4>
938
+ <ul class="tsd-parameters">
939
+ <li>
940
+ <h5>message: <span class="tsd-signature-type">any</span></h5>
941
+ <div class="tsd-comment tsd-typography">
942
+ <p>the arbitrary message that was signed</p>
943
+ </div>
944
+ </li>
945
+ <li>
946
+ <h5>publicKey: <span class="tsd-signature-type">string</span></h5>
947
+ <div class="tsd-comment tsd-typography">
948
+ <p>the public key of the private key that was used to sign</p>
949
+ </div>
950
+ </li>
951
+ <li>
952
+ <h5>signature: <span class="tsd-signature-type">string</span></h5>
953
+ <div class="tsd-comment tsd-typography">
954
+ <p>the signature</p>
955
+ </div>
956
+ </li>
957
+ </ul>
958
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
959
+ <p>whether the signature is valid</p>
960
+ </li>
961
+ </ul>
962
+ </section>
963
+ </section>
964
+ </div>
965
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
966
+ <nav class="tsd-navigation primary">
967
+ <ul>
968
+ <li class="globals ">
969
+ <a href="../globals.html"><em>Globals</em></a>
970
+ </li>
971
+ </ul>
972
+ </nav>
973
+ <nav class="tsd-navigation secondary menu-sticky">
974
+ <ul class="before-current">
975
+ <li class=" tsd-kind-class">
976
+ <a href="address.html" class="tsd-kind-icon">Address</a>
977
+ </li>
978
+ <li class=" tsd-kind-class">
979
+ <a href="addressprefix.html" class="tsd-kind-icon">Address<wbr>Prefix</a>
980
+ </li>
981
+ <li class=" tsd-kind-class">
982
+ <a href="block.html" class="tsd-kind-icon">Block</a>
983
+ </li>
984
+ <li class=" tsd-kind-class">
985
+ <a href="blocktemplate.html" class="tsd-kind-icon">Block<wbr>Template</a>
986
+ </li>
987
+ </ul>
988
+ <ul class="current">
989
+ <li class="current tsd-kind-class">
990
+ <a href="cryptonote.html" class="tsd-kind-icon">Crypto<wbr>Note</a>
991
+ <ul>
992
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
993
+ <a href="cryptonote.html#constructor" class="tsd-kind-icon">constructor</a>
994
+ </li>
995
+ <li class=" tsd-kind-method tsd-parent-kind-class">
996
+ <a href="cryptonote.html#absolutetorelativeoffsets" class="tsd-kind-icon">absolute<wbr>ToRelative<wbr>Offsets</a>
997
+ </li>
998
+ <li class=" tsd-kind-method tsd-parent-kind-class">
999
+ <a href="cryptonote.html#calculateminimumtransactionfee" class="tsd-kind-icon">calculate<wbr>Minimum<wbr>Transaction<wbr>Fee</a>
1000
+ </li>
1001
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1002
+ <a href="cryptonote.html#completetransaction" class="tsd-kind-icon">complete<wbr>Transaction</a>
1003
+ </li>
1004
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1005
+ <a href="cryptonote.html#createintegratedaddress" class="tsd-kind-icon">create<wbr>Integrated<wbr>Address</a>
1006
+ </li>
1007
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1008
+ <a href="cryptonote.html#createtransaction" class="tsd-kind-icon">create<wbr>Transaction</a>
1009
+ </li>
1010
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1011
+ <a href="cryptonote.html#createtransactionstructure" class="tsd-kind-icon">create<wbr>Transaction<wbr>Structure</a>
1012
+ </li>
1013
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1014
+ <a href="cryptonote.html#formatmoney" class="tsd-kind-icon">format<wbr>Money</a>
1015
+ </li>
1016
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1017
+ <a href="cryptonote.html#generatekeyimage" class="tsd-kind-icon">generate<wbr>Key<wbr>Image</a>
1018
+ </li>
1019
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1020
+ <a href="cryptonote.html#generatekeyimageprimitive" class="tsd-kind-icon">generate<wbr>Key<wbr>Image<wbr>Primitive</a>
1021
+ </li>
1022
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1023
+ <a href="cryptonote.html#generatetransactionoutputs" class="tsd-kind-icon">generate<wbr>Transaction<wbr>Outputs</a>
1024
+ </li>
1025
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1026
+ <a href="cryptonote.html#isourtransactionoutput" class="tsd-kind-icon">is<wbr>Our<wbr>Transaction<wbr>Output</a>
1027
+ </li>
1028
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1029
+ <a href="cryptonote.html#preparetransaction" class="tsd-kind-icon">prepare<wbr>Transaction</a>
1030
+ </li>
1031
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1032
+ <a href="cryptonote.html#privatekeytopublickey" class="tsd-kind-icon">private<wbr>Key<wbr>ToPublic<wbr>Key</a>
1033
+ </li>
1034
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1035
+ <a href="cryptonote.html#relativetoabsoluteoffsets" class="tsd-kind-icon">relative<wbr>ToAbsolute<wbr>Offsets</a>
1036
+ </li>
1037
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1038
+ <a href="cryptonote.html#scantransactionoutputs" class="tsd-kind-icon">scan<wbr>Transaction<wbr>Outputs</a>
1039
+ </li>
1040
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1041
+ <a href="cryptonote.html#signmessage" class="tsd-kind-icon">sign<wbr>Message</a>
1042
+ </li>
1043
+ <li class=" tsd-kind-method tsd-parent-kind-class">
1044
+ <a href="cryptonote.html#verifymessagesignature" class="tsd-kind-icon">verify<wbr>Message<wbr>Signature</a>
1045
+ </li>
1046
+ </ul>
1047
+ </li>
1048
+ </ul>
1049
+ <ul class="after-current">
1050
+ <li class=" tsd-kind-class">
1051
+ <a href="levinpacket.html" class="tsd-kind-icon">Levin<wbr>Packet</a>
1052
+ </li>
1053
+ <li class=" tsd-kind-class">
1054
+ <a href="multisig.html" class="tsd-kind-icon">Multisig</a>
1055
+ </li>
1056
+ <li class=" tsd-kind-class">
1057
+ <a href="multisigmessage.html" class="tsd-kind-icon">Multisig<wbr>Message</a>
1058
+ </li>
1059
+ <li class=" tsd-kind-class">
1060
+ <a href="parentblock.html" class="tsd-kind-icon">Parent<wbr>Block</a>
1061
+ </li>
1062
+ <li class=" tsd-kind-class">
1063
+ <a href="transaction.html" class="tsd-kind-icon">Transaction</a>
1064
+ </li>
1065
+ </ul>
1066
+ </nav>
1067
+ </div>
1068
+ </div>
1069
+ </div>
1070
+ <footer class="with-border-bottom">
1071
+ <div class="container">
1072
+ <h2>Legend</h2>
1073
+ <div class="tsd-legend-group">
1074
+ <ul class="tsd-legend">
1075
+ <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
1076
+ <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
1077
+ <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
1078
+ <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
1079
+ <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
1080
+ <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
1081
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
1082
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
1083
+ </ul>
1084
+ <ul class="tsd-legend">
1085
+ <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
1086
+ <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
1087
+ <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
1088
+ <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
1089
+ </ul>
1090
+ <ul class="tsd-legend">
1091
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
1092
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
1093
+ <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
1094
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
1095
+ <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
1096
+ <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
1097
+ </ul>
1098
+ <ul class="tsd-legend">
1099
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
1100
+ <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
1101
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
1102
+ <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
1103
+ <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
1104
+ <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
1105
+ <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
1106
+ </ul>
1107
+ <ul class="tsd-legend">
1108
+ <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
1109
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
1110
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
1111
+ <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
1112
+ </ul>
1113
+ <ul class="tsd-legend">
1114
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
1115
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
1116
+ <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
1117
+ </ul>
1118
+ <ul class="tsd-legend">
1119
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
1120
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
1121
+ <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
1122
+ </ul>
1123
+ <ul class="tsd-legend">
1124
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
1125
+ <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
1126
+ </ul>
1127
+ </div>
1128
+ </div>
1129
+ </footer>
1130
+ <div class="container tsd-generator">
1131
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
1132
+ </div>
1133
+ <div class="overlay"></div>
1134
+ <script src="../assets/js/main.js"></script>
1135
+ <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
1136
+ </body>
1137
+ </html>