quantum-coin-js-sdk 1.0.6

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 (10) hide show
  1. package/.github/workflows/publish-npmjs.yaml +22 -0
  2. package/.gitignore +2 -0
  3. package/README.md +716 -0
  4. package/example/README.md +3 -0
  5. package/example/example.js +195 -0
  6. package/example/package-lock.json +127 -0
  7. package/example/package.json +15 -0
  8. package/index.js +1178 -0
  9. package/package.json +33 -0
  10. package/wasm_exec.js +561 -0
package/README.md ADDED
@@ -0,0 +1,716 @@
1
+ <a name="module_quantum-coin-js-sdk"></a>
2
+
3
+ ## quantum-coin-js-sdk
4
+ Quantum Coin JS SDK provides functionality to interact with the Quantum Coin Blockchain using the Relay APIs.
5
+
6
+ **Example**
7
+ ```js
8
+ Installation:
9
+ ```
10
+
11
+ * [quantum-coin-js-sdk](#module_quantum-coin-js-sdk)
12
+ * [~Config](#module_quantum-coin-js-sdk..Config)
13
+ * [new Config(readUrl, writeUrl, chainId, readApiKey, writeApiKey)](#new_module_quantum-coin-js-sdk..Config_new)
14
+ * [.readUrl](#module_quantum-coin-js-sdk..Config+readUrl) : <code>string</code>
15
+ * [.writeUrl](#module_quantum-coin-js-sdk..Config+writeUrl) : <code>string</code>
16
+ * [.chainId](#module_quantum-coin-js-sdk..Config+chainId) : <code>number</code>
17
+ * [.readApiKey](#module_quantum-coin-js-sdk..Config+readApiKey) : <code>string</code>
18
+ * [.writeApiKey](#module_quantum-coin-js-sdk..Config+writeApiKey) : <code>string</code>
19
+ * [~Wallet](#module_quantum-coin-js-sdk..Wallet)
20
+ * [new Wallet(address, privateKey, publicKey)](#new_module_quantum-coin-js-sdk..Wallet_new)
21
+ * [.address](#module_quantum-coin-js-sdk..Wallet+address) : <code>string</code>
22
+ * [.privateKey](#module_quantum-coin-js-sdk..Wallet+privateKey)
23
+ * [.publicKey](#module_quantum-coin-js-sdk..Wallet+publicKey)
24
+ * [~BlockDetails](#module_quantum-coin-js-sdk..BlockDetails)
25
+ * [.blockNumber](#module_quantum-coin-js-sdk..BlockDetails+blockNumber) : <code>number</code>
26
+ * [~LatestBlockDetailsResult](#module_quantum-coin-js-sdk..LatestBlockDetailsResult)
27
+ * [.resultCode](#module_quantum-coin-js-sdk..LatestBlockDetailsResult+resultCode) : <code>number</code>
28
+ * [.blockDetails](#module_quantum-coin-js-sdk..LatestBlockDetailsResult+blockDetails) : <code>BlockDetails</code>
29
+ * [.response](#module_quantum-coin-js-sdk..LatestBlockDetailsResult+response) : <code>Object</code>
30
+ * [~AccountDetails](#module_quantum-coin-js-sdk..AccountDetails)
31
+ * [.address](#module_quantum-coin-js-sdk..AccountDetails+address) : <code>string</code>
32
+ * [.balance](#module_quantum-coin-js-sdk..AccountDetails+balance) : <code>string</code>
33
+ * [.nonce](#module_quantum-coin-js-sdk..AccountDetails+nonce) : <code>number</code>
34
+ * [.blockNumber](#module_quantum-coin-js-sdk..AccountDetails+blockNumber) : <code>number</code>
35
+ * [~AccountDetailsResult](#module_quantum-coin-js-sdk..AccountDetailsResult)
36
+ * [.resultCode](#module_quantum-coin-js-sdk..AccountDetailsResult+resultCode) : <code>number</code>
37
+ * [.accountDetails](#module_quantum-coin-js-sdk..AccountDetailsResult+accountDetails) : <code>AccountDetails</code>
38
+ * [.response](#module_quantum-coin-js-sdk..AccountDetailsResult+response) : <code>Object</code>
39
+ * [~SignResult](#module_quantum-coin-js-sdk..SignResult)
40
+ * [.resultCode](#module_quantum-coin-js-sdk..SignResult+resultCode) : <code>number</code>
41
+ * [.txnHash](#module_quantum-coin-js-sdk..SignResult+txnHash) : <code>string</code>
42
+ * [.txnData](#module_quantum-coin-js-sdk..SignResult+txnData) : <code>string</code>
43
+ * [~SendResult](#module_quantum-coin-js-sdk..SendResult)
44
+ * [.resultCode](#module_quantum-coin-js-sdk..SendResult+resultCode) : <code>number</code>
45
+ * [.txnHash](#module_quantum-coin-js-sdk..SendResult+txnHash) : <code>string</code>
46
+ * [.response](#module_quantum-coin-js-sdk..SendResult+response) : <code>Object</code>
47
+ * [~TransactionReceipt](#module_quantum-coin-js-sdk..TransactionReceipt)
48
+ * [.cumulativeGasUsed](#module_quantum-coin-js-sdk..TransactionReceipt+cumulativeGasUsed) : <code>string</code>
49
+ * [.effectiveGasPrice](#module_quantum-coin-js-sdk..TransactionReceipt+effectiveGasPrice) : <code>string</code>
50
+ * [.gasUsed](#module_quantum-coin-js-sdk..TransactionReceipt+gasUsed) : <code>string</code>
51
+ * [.status](#module_quantum-coin-js-sdk..TransactionReceipt+status) : <code>string</code>
52
+ * [.hash](#module_quantum-coin-js-sdk..TransactionReceipt+hash) : <code>string</code>
53
+ * [.type](#module_quantum-coin-js-sdk..TransactionReceipt+type) : <code>string</code>
54
+ * [~TransactionDetails](#module_quantum-coin-js-sdk..TransactionDetails)
55
+ * [.blockHash](#module_quantum-coin-js-sdk..TransactionDetails+blockHash) : <code>string</code>
56
+ * [.blockNumber](#module_quantum-coin-js-sdk..TransactionDetails+blockNumber) : <code>number</code>
57
+ * [.from](#module_quantum-coin-js-sdk..TransactionDetails+from) : <code>string</code>
58
+ * [.gas](#module_quantum-coin-js-sdk..TransactionDetails+gas) : <code>string</code>
59
+ * [.gasPrice](#module_quantum-coin-js-sdk..TransactionDetails+gasPrice) : <code>string</code>
60
+ * [.hash](#module_quantum-coin-js-sdk..TransactionDetails+hash) : <code>string</code>
61
+ * [.input](#module_quantum-coin-js-sdk..TransactionDetails+input) : <code>string</code>
62
+ * [.nonce](#module_quantum-coin-js-sdk..TransactionDetails+nonce) : <code>number</code>
63
+ * [.to](#module_quantum-coin-js-sdk..TransactionDetails+to) : <code>string</code>
64
+ * [.value](#module_quantum-coin-js-sdk..TransactionDetails+value) : <code>string</code>
65
+ * [.receipt](#module_quantum-coin-js-sdk..TransactionDetails+receipt) : <code>TransactionReceipt</code>
66
+ * [~TransactionDetailsResult](#module_quantum-coin-js-sdk..TransactionDetailsResult)
67
+ * [.resultCode](#module_quantum-coin-js-sdk..TransactionDetailsResult+resultCode) : <code>number</code>
68
+ * [.transactionDetails](#module_quantum-coin-js-sdk..TransactionDetailsResult+transactionDetails) : <code>TransactionDetails</code>
69
+ * [.response](#module_quantum-coin-js-sdk..TransactionDetailsResult+response) : <code>Object</code>
70
+ * [~initialize(clientConfig)](#module_quantum-coin-js-sdk..initialize) ⇒ <code>Promise.&lt;boolean&gt;</code>
71
+ * [~isAddressValid(address)](#module_quantum-coin-js-sdk..isAddressValid) ⇒ <code>boolean</code>
72
+ * [~newWallet()](#module_quantum-coin-js-sdk..newWallet) ⇒ <code>Wallet</code>
73
+ * [~verifyWallet(wallet)](#module_quantum-coin-js-sdk..verifyWallet) ⇒ <code>boolean</code>
74
+ * [~serializeWallet(wallet)](#module_quantum-coin-js-sdk..serializeWallet) ⇒ <code>string</code>
75
+ * [~deserializeWallet(walletJson)](#module_quantum-coin-js-sdk..deserializeWallet) ⇒ <code>Wallet</code>
76
+ * [~postTransaction(txnData)](#module_quantum-coin-js-sdk..postTransaction) ⇒ <code>Promise.&lt;SendResult&gt;</code>
77
+ * [~getLatestBlockDetails()](#module_quantum-coin-js-sdk..getLatestBlockDetails) ⇒ <code>Promise.&lt;BlockDetailsResult&gt;</code>
78
+ * [~getAccountDetails(address)](#module_quantum-coin-js-sdk..getAccountDetails) ⇒ <code>Promise.&lt;AccountDetailsResult&gt;</code>
79
+ * [~getTransactionDetails(txnHash)](#module_quantum-coin-js-sdk..getTransactionDetails) ⇒ <code>Promise.&lt;TransactionDetailsResult&gt;</code>
80
+ * [~signSendCoinTransaction(wallet, toAddress, coinsInWei, nonce)](#module_quantum-coin-js-sdk..signSendCoinTransaction) ⇒ <code>SignResult</code>
81
+ * [~sendCoins(wallet, toAddress, coinsInWei, nonce)](#module_quantum-coin-js-sdk..sendCoins) ⇒ <code>Promise.&lt;SendResult&gt;</code>
82
+
83
+ <a name="module_quantum-coin-js-sdk..Config"></a>
84
+
85
+ ### quantum-coin-js-sdk~Config
86
+ This is the configuration class required to initialize and interact with Quantum Coin blockchain
87
+
88
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
89
+ **Access**: public
90
+
91
+ * [~Config](#module_quantum-coin-js-sdk..Config)
92
+ * [new Config(readUrl, writeUrl, chainId, readApiKey, writeApiKey)](#new_module_quantum-coin-js-sdk..Config_new)
93
+ * [.readUrl](#module_quantum-coin-js-sdk..Config+readUrl) : <code>string</code>
94
+ * [.writeUrl](#module_quantum-coin-js-sdk..Config+writeUrl) : <code>string</code>
95
+ * [.chainId](#module_quantum-coin-js-sdk..Config+chainId) : <code>number</code>
96
+ * [.readApiKey](#module_quantum-coin-js-sdk..Config+readApiKey) : <code>string</code>
97
+ * [.writeApiKey](#module_quantum-coin-js-sdk..Config+writeApiKey) : <code>string</code>
98
+
99
+ <a name="new_module_quantum-coin-js-sdk..Config_new"></a>
100
+
101
+ #### new Config(readUrl, writeUrl, chainId, readApiKey, writeApiKey)
102
+ Creates a config class
103
+
104
+
105
+ | Param | Type | Description |
106
+ | --- | --- | --- |
107
+ | readUrl | <code>string</code> | The Read API URL pointing to a read relay. See https://github.com/DogeProtocol/go-dp/tree/dogep/relay. The following URLs are community maintained. Please use your own relay service. Mainnet: https://relayread.quantumcoin.org Testnet T4: https://t4-relayread.quantumcoin.org |
108
+ | writeUrl | <code>string</code> | The Write API URL pointing to a write relay. See https://github.com/DogeProtocol/go-dp/tree/dogep/relay. The following URLs are community maintained. Please use your own relay service. Mainnet: https://relaywrite.quantumcoin.org Testnet T4: https://t4-relaywrite.quantumcoin.org |
109
+ | chainId | <code>number</code> | The chain id of the blockchain. Mainnet chainId is 123123. Testnet T4 chainId is 310324. |
110
+ | readApiKey | <code>string</code> | Optional parameter if authorization is enabled for the relay service. API Key for authorization. Defaults to null which indicates no authorization. |
111
+ | writeApiKey | <code>string</code> | Optional parameter if authorization is enabled for the relay service. API Key for authorization. Defaults to null which indicates no authorization. |
112
+
113
+ <a name="module_quantum-coin-js-sdk..Config+readUrl"></a>
114
+
115
+ #### config.readUrl : <code>string</code>
116
+ The Read API URL pointing to a read relay. See https://github.com/DogeProtocol/go-dp/tree/dogep/relay
117
+
118
+ **Kind**: instance property of [<code>Config</code>](#module_quantum-coin-js-sdk..Config)
119
+ **Access**: public
120
+ <a name="module_quantum-coin-js-sdk..Config+writeUrl"></a>
121
+
122
+ #### config.writeUrl : <code>string</code>
123
+ The Read API URL pointing to a read relay. See https://github.com/DogeProtocol/go-dp/tree/dogep/relay
124
+
125
+ **Kind**: instance property of [<code>Config</code>](#module_quantum-coin-js-sdk..Config)
126
+ **Access**: public
127
+ <a name="module_quantum-coin-js-sdk..Config+chainId"></a>
128
+
129
+ #### config.chainId : <code>number</code>
130
+ The chain id of the blockchain. Mainnet chainId is 123123. Testnet T4 chainId is 310324.
131
+
132
+ **Kind**: instance property of [<code>Config</code>](#module_quantum-coin-js-sdk..Config)
133
+ **Access**: public
134
+ <a name="module_quantum-coin-js-sdk..Config+readApiKey"></a>
135
+
136
+ #### config.readApiKey : <code>string</code>
137
+ API Key for authorization if authorization is enabled for the relay service. Defaults to null which indicates no authorization.
138
+
139
+ **Kind**: instance property of [<code>Config</code>](#module_quantum-coin-js-sdk..Config)
140
+ **Access**: public
141
+ <a name="module_quantum-coin-js-sdk..Config+writeApiKey"></a>
142
+
143
+ #### config.writeApiKey : <code>string</code>
144
+ API Key for authorization if authorization is enabled for the relay service. Defaults to null which indicates no authorization.
145
+
146
+ **Kind**: instance property of [<code>Config</code>](#module_quantum-coin-js-sdk..Config)
147
+ **Access**: public
148
+ <a name="module_quantum-coin-js-sdk..Wallet"></a>
149
+
150
+ ### quantum-coin-js-sdk~Wallet
151
+ This class represents a Wallet. Use the verifyWallet function to verify if a wallet is valid. Verifying the wallet is highly recommended, especially if it comes from an untrusted source. For more details on the underlying cryptography of the Wallet, see https://github.com/DogeProtocol/hybrid-pqc
152
+
153
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
154
+ **Access**: public
155
+
156
+ * [~Wallet](#module_quantum-coin-js-sdk..Wallet)
157
+ * [new Wallet(address, privateKey, publicKey)](#new_module_quantum-coin-js-sdk..Wallet_new)
158
+ * [.address](#module_quantum-coin-js-sdk..Wallet+address) : <code>string</code>
159
+ * [.privateKey](#module_quantum-coin-js-sdk..Wallet+privateKey)
160
+ * [.publicKey](#module_quantum-coin-js-sdk..Wallet+publicKey)
161
+
162
+ <a name="new_module_quantum-coin-js-sdk..Wallet_new"></a>
163
+
164
+ #### new Wallet(address, privateKey, publicKey)
165
+ Creates a Wallet class. The constructor does not verify the wallet. To verify a wallet, call the verifyWallet function explicitly.
166
+
167
+
168
+ | Param | Type | Description |
169
+ | --- | --- | --- |
170
+ | address | <code>string</code> | Address of the wallet |
171
+ | privateKey | <code>Array.&lt;byte&gt;</code> | Private Key byte array of the wallet |
172
+ | publicKey | <code>Array.&lt;byte&gt;</code> | The chain id of the blockchain. Mainnet chainId is 123123. Testnet T4 chainId is 310324. |
173
+
174
+ <a name="module_quantum-coin-js-sdk..Wallet+address"></a>
175
+
176
+ #### wallet.address : <code>string</code>
177
+ Address of the wallet. Is 66 bytes in length including 0x (if the wallet is valid).
178
+
179
+ **Kind**: instance property of [<code>Wallet</code>](#module_quantum-coin-js-sdk..Wallet)
180
+ **Access**: public
181
+ <a name="module_quantum-coin-js-sdk..Wallet+privateKey"></a>
182
+
183
+ #### wallet.privateKey
184
+ Private Key byte array of the wallet. Is 4064 bytes in length (if the wallet is valid).
185
+
186
+ **Kind**: instance property of [<code>Wallet</code>](#module_quantum-coin-js-sdk..Wallet)
187
+ **Access**: public
188
+ <a name="module_quantum-coin-js-sdk..Wallet+publicKey"></a>
189
+
190
+ #### wallet.publicKey
191
+ Public Key byte array of the wallet. Is 1408 bytes in length (if the wallet is valid).
192
+
193
+ **Kind**: instance property of [<code>Wallet</code>](#module_quantum-coin-js-sdk..Wallet)
194
+ **Access**: public
195
+ <a name="module_quantum-coin-js-sdk..BlockDetails"></a>
196
+
197
+ ### quantum-coin-js-sdk~BlockDetails
198
+ This class represents a Block.
199
+
200
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
201
+ **Access**: public
202
+ <a name="module_quantum-coin-js-sdk..BlockDetails+blockNumber"></a>
203
+
204
+ #### blockDetails.blockNumber : <code>number</code>
205
+ Block Number of the block
206
+
207
+ **Kind**: instance property of [<code>BlockDetails</code>](#module_quantum-coin-js-sdk..BlockDetails)
208
+ **Access**: public
209
+ <a name="module_quantum-coin-js-sdk..LatestBlockDetailsResult"></a>
210
+
211
+ ### quantum-coin-js-sdk~LatestBlockDetailsResult
212
+ This class represents a result from invoking the getLatestBlock function.
213
+
214
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
215
+ **Access**: public
216
+
217
+ * [~LatestBlockDetailsResult](#module_quantum-coin-js-sdk..LatestBlockDetailsResult)
218
+ * [.resultCode](#module_quantum-coin-js-sdk..LatestBlockDetailsResult+resultCode) : <code>number</code>
219
+ * [.blockDetails](#module_quantum-coin-js-sdk..LatestBlockDetailsResult+blockDetails) : <code>BlockDetails</code>
220
+ * [.response](#module_quantum-coin-js-sdk..LatestBlockDetailsResult+response) : <code>Object</code>
221
+
222
+ <a name="module_quantum-coin-js-sdk..LatestBlockDetailsResult+resultCode"></a>
223
+
224
+ #### latestBlockDetailsResult.resultCode : <code>number</code>
225
+ Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.
226
+
227
+ **Kind**: instance property of [<code>LatestBlockDetailsResult</code>](#module_quantum-coin-js-sdk..LatestBlockDetailsResult)
228
+ **Access**: public
229
+ <a name="module_quantum-coin-js-sdk..LatestBlockDetailsResult+blockDetails"></a>
230
+
231
+ #### latestBlockDetailsResult.blockDetails : <code>BlockDetails</code>
232
+ An object of type BlockDetails representing the block. This value is null if the value of resultCode is not 0.
233
+
234
+ **Kind**: instance property of [<code>LatestBlockDetailsResult</code>](#module_quantum-coin-js-sdk..LatestBlockDetailsResult)
235
+ **Access**: public
236
+ <a name="module_quantum-coin-js-sdk..LatestBlockDetailsResult+response"></a>
237
+
238
+ #### latestBlockDetailsResult.response : <code>Object</code>
239
+ An object of representing the raw Response returned by the service. For details, see https://developer.mozilla.org/en-US/docs/Web/API/Response. This value can be null if the value of resultCode is not 0.
240
+
241
+ **Kind**: instance property of [<code>LatestBlockDetailsResult</code>](#module_quantum-coin-js-sdk..LatestBlockDetailsResult)
242
+ **Access**: public
243
+ <a name="module_quantum-coin-js-sdk..AccountDetails"></a>
244
+
245
+ ### quantum-coin-js-sdk~AccountDetails
246
+ This class represents an Account.
247
+
248
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
249
+ **Access**: public
250
+
251
+ * [~AccountDetails](#module_quantum-coin-js-sdk..AccountDetails)
252
+ * [.address](#module_quantum-coin-js-sdk..AccountDetails+address) : <code>string</code>
253
+ * [.balance](#module_quantum-coin-js-sdk..AccountDetails+balance) : <code>string</code>
254
+ * [.nonce](#module_quantum-coin-js-sdk..AccountDetails+nonce) : <code>number</code>
255
+ * [.blockNumber](#module_quantum-coin-js-sdk..AccountDetails+blockNumber) : <code>number</code>
256
+
257
+ <a name="module_quantum-coin-js-sdk..AccountDetails+address"></a>
258
+
259
+ #### accountDetails.address : <code>string</code>
260
+ Address of the wallet. Is 66 bytes in length including 0x.
261
+
262
+ **Kind**: instance property of [<code>AccountDetails</code>](#module_quantum-coin-js-sdk..AccountDetails)
263
+ **Access**: public
264
+ <a name="module_quantum-coin-js-sdk..AccountDetails+balance"></a>
265
+
266
+ #### accountDetails.balance : <code>string</code>
267
+ Balance of the account in wei. To convert this to ethers, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei
268
+
269
+ **Kind**: instance property of [<code>AccountDetails</code>](#module_quantum-coin-js-sdk..AccountDetails)
270
+ **Access**: public
271
+ <a name="module_quantum-coin-js-sdk..AccountDetails+nonce"></a>
272
+
273
+ #### accountDetails.nonce : <code>number</code>
274
+ A monotonically increasing number representing the nonce of the account. After each transaction from the account that gets registered in the blockchain, the nonce increases by 1.
275
+
276
+ **Kind**: instance property of [<code>AccountDetails</code>](#module_quantum-coin-js-sdk..AccountDetails)
277
+ **Access**: public
278
+ <a name="module_quantum-coin-js-sdk..AccountDetails+blockNumber"></a>
279
+
280
+ #### accountDetails.blockNumber : <code>number</code>
281
+ The block number as of which the Account details was retrieved.
282
+
283
+ **Kind**: instance property of [<code>AccountDetails</code>](#module_quantum-coin-js-sdk..AccountDetails)
284
+ **Access**: public
285
+ <a name="module_quantum-coin-js-sdk..AccountDetailsResult"></a>
286
+
287
+ ### quantum-coin-js-sdk~AccountDetailsResult
288
+ This class represents a result from invoking the getAccountDetails function.
289
+
290
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
291
+ **Access**: public
292
+
293
+ * [~AccountDetailsResult](#module_quantum-coin-js-sdk..AccountDetailsResult)
294
+ * [.resultCode](#module_quantum-coin-js-sdk..AccountDetailsResult+resultCode) : <code>number</code>
295
+ * [.accountDetails](#module_quantum-coin-js-sdk..AccountDetailsResult+accountDetails) : <code>AccountDetails</code>
296
+ * [.response](#module_quantum-coin-js-sdk..AccountDetailsResult+response) : <code>Object</code>
297
+
298
+ <a name="module_quantum-coin-js-sdk..AccountDetailsResult+resultCode"></a>
299
+
300
+ #### accountDetailsResult.resultCode : <code>number</code>
301
+ Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.
302
+
303
+ **Kind**: instance property of [<code>AccountDetailsResult</code>](#module_quantum-coin-js-sdk..AccountDetailsResult)
304
+ **Access**: public
305
+ <a name="module_quantum-coin-js-sdk..AccountDetailsResult+accountDetails"></a>
306
+
307
+ #### accountDetailsResult.accountDetails : <code>AccountDetails</code>
308
+ An object of type AccountDetails representing the block. This value is null if the value of resultCode is not 0.
309
+
310
+ **Kind**: instance property of [<code>AccountDetailsResult</code>](#module_quantum-coin-js-sdk..AccountDetailsResult)
311
+ **Access**: public
312
+ <a name="module_quantum-coin-js-sdk..AccountDetailsResult+response"></a>
313
+
314
+ #### accountDetailsResult.response : <code>Object</code>
315
+ An object of representing the raw Response returned by the service. For details, see https://developer.mozilla.org/en-US/docs/Web/API/Response. This value can be null if the value of resultCode is not 0.
316
+
317
+ **Kind**: instance property of [<code>AccountDetailsResult</code>](#module_quantum-coin-js-sdk..AccountDetailsResult)
318
+ **Access**: public
319
+ <a name="module_quantum-coin-js-sdk..SignResult"></a>
320
+
321
+ ### quantum-coin-js-sdk~SignResult
322
+ This class represents a result from invoking the signSendCoinTransaction function.
323
+
324
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
325
+ **Access**: public
326
+
327
+ * [~SignResult](#module_quantum-coin-js-sdk..SignResult)
328
+ * [.resultCode](#module_quantum-coin-js-sdk..SignResult+resultCode) : <code>number</code>
329
+ * [.txnHash](#module_quantum-coin-js-sdk..SignResult+txnHash) : <code>string</code>
330
+ * [.txnData](#module_quantum-coin-js-sdk..SignResult+txnData) : <code>string</code>
331
+
332
+ <a name="module_quantum-coin-js-sdk..SignResult+resultCode"></a>
333
+
334
+ #### signResult.resultCode : <code>number</code>
335
+ Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.
336
+
337
+ **Kind**: instance property of [<code>SignResult</code>](#module_quantum-coin-js-sdk..SignResult)
338
+ **Access**: public
339
+ <a name="module_quantum-coin-js-sdk..SignResult+txnHash"></a>
340
+
341
+ #### signResult.txnHash : <code>string</code>
342
+ Hash of the Transaction, to uniquely identify it. Is 66 bytes in length including 0x. This value is null if the value of resultCode is not 0.
343
+
344
+ **Kind**: instance property of [<code>SignResult</code>](#module_quantum-coin-js-sdk..SignResult)
345
+ **Access**: public
346
+ <a name="module_quantum-coin-js-sdk..SignResult+txnData"></a>
347
+
348
+ #### signResult.txnData : <code>string</code>
349
+ A payload representing the signed transaction.
350
+
351
+ **Kind**: instance property of [<code>SignResult</code>](#module_quantum-coin-js-sdk..SignResult)
352
+ **Access**: public
353
+ <a name="module_quantum-coin-js-sdk..SendResult"></a>
354
+
355
+ ### quantum-coin-js-sdk~SendResult
356
+ This class represents a result from invoking the sendCoins function.
357
+
358
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
359
+ **Access**: public
360
+
361
+ * [~SendResult](#module_quantum-coin-js-sdk..SendResult)
362
+ * [.resultCode](#module_quantum-coin-js-sdk..SendResult+resultCode) : <code>number</code>
363
+ * [.txnHash](#module_quantum-coin-js-sdk..SendResult+txnHash) : <code>string</code>
364
+ * [.response](#module_quantum-coin-js-sdk..SendResult+response) : <code>Object</code>
365
+
366
+ <a name="module_quantum-coin-js-sdk..SendResult+resultCode"></a>
367
+
368
+ #### sendResult.resultCode : <code>number</code>
369
+ Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.
370
+
371
+ **Kind**: instance property of [<code>SendResult</code>](#module_quantum-coin-js-sdk..SendResult)
372
+ **Access**: public
373
+ <a name="module_quantum-coin-js-sdk..SendResult+txnHash"></a>
374
+
375
+ #### sendResult.txnHash : <code>string</code>
376
+ Hash of the Transaction, to uniquely identify it. Is 66 bytes in length including 0x. This value is null if the value of resultCode is not 0.
377
+
378
+ **Kind**: instance property of [<code>SendResult</code>](#module_quantum-coin-js-sdk..SendResult)
379
+ **Access**: public
380
+ <a name="module_quantum-coin-js-sdk..SendResult+response"></a>
381
+
382
+ #### sendResult.response : <code>Object</code>
383
+ An object of representing the raw Response returned by the service. For details, see https://developer.mozilla.org/en-US/docs/Web/API/Response. This value can be null if the value of resultCode is not 0.
384
+
385
+ **Kind**: instance property of [<code>SendResult</code>](#module_quantum-coin-js-sdk..SendResult)
386
+ **Access**: public
387
+ <a name="module_quantum-coin-js-sdk..TransactionReceipt"></a>
388
+
389
+ ### quantum-coin-js-sdk~TransactionReceipt
390
+ This class represents a Receipt of a transaction that was registered in the blockchain. The transactionReceipt field can be null unless the transaction is registered with the blockchain.
391
+
392
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
393
+ **Access**: public
394
+
395
+ * [~TransactionReceipt](#module_quantum-coin-js-sdk..TransactionReceipt)
396
+ * [.cumulativeGasUsed](#module_quantum-coin-js-sdk..TransactionReceipt+cumulativeGasUsed) : <code>string</code>
397
+ * [.effectiveGasPrice](#module_quantum-coin-js-sdk..TransactionReceipt+effectiveGasPrice) : <code>string</code>
398
+ * [.gasUsed](#module_quantum-coin-js-sdk..TransactionReceipt+gasUsed) : <code>string</code>
399
+ * [.status](#module_quantum-coin-js-sdk..TransactionReceipt+status) : <code>string</code>
400
+ * [.hash](#module_quantum-coin-js-sdk..TransactionReceipt+hash) : <code>string</code>
401
+ * [.type](#module_quantum-coin-js-sdk..TransactionReceipt+type) : <code>string</code>
402
+
403
+ <a name="module_quantum-coin-js-sdk..TransactionReceipt+cumulativeGasUsed"></a>
404
+
405
+ #### transactionReceipt.cumulativeGasUsed : <code>string</code>
406
+ A hexadecimal string representing the total amount of gas used when this transaction was executed in the block.
407
+
408
+ **Kind**: instance property of [<code>TransactionReceipt</code>](#module_quantum-coin-js-sdk..TransactionReceipt)
409
+ **Access**: public
410
+ <a name="module_quantum-coin-js-sdk..TransactionReceipt+effectiveGasPrice"></a>
411
+
412
+ #### transactionReceipt.effectiveGasPrice : <code>string</code>
413
+ A hexadecimal string representing the sum of the base fee and tip paid per unit of gas.
414
+
415
+ **Kind**: instance property of [<code>TransactionReceipt</code>](#module_quantum-coin-js-sdk..TransactionReceipt)
416
+ **Access**: public
417
+ <a name="module_quantum-coin-js-sdk..TransactionReceipt+gasUsed"></a>
418
+
419
+ #### transactionReceipt.gasUsed : <code>string</code>
420
+ A hexadecimal string representing the amount of gas used by this specific transaction alone.
421
+
422
+ **Kind**: instance property of [<code>TransactionReceipt</code>](#module_quantum-coin-js-sdk..TransactionReceipt)
423
+ **Access**: public
424
+ <a name="module_quantum-coin-js-sdk..TransactionReceipt+status"></a>
425
+
426
+ #### transactionReceipt.status : <code>string</code>
427
+ A hexadecimal string representing either 0x1 (success) or 0x0 (failure). Failed transactions can also incur gas fee. You should consider the transaction as succeeded only if the status value is 0x1 (success).
428
+
429
+ **Kind**: instance property of [<code>TransactionReceipt</code>](#module_quantum-coin-js-sdk..TransactionReceipt)
430
+ **Access**: public
431
+ <a name="module_quantum-coin-js-sdk..TransactionReceipt+hash"></a>
432
+
433
+ #### transactionReceipt.hash : <code>string</code>
434
+ Hash of the Transaction, to uniquely identify it. Is 66 bytes in length including 0x.
435
+
436
+ **Kind**: instance property of [<code>TransactionReceipt</code>](#module_quantum-coin-js-sdk..TransactionReceipt)
437
+ **Access**: public
438
+ <a name="module_quantum-coin-js-sdk..TransactionReceipt+type"></a>
439
+
440
+ #### transactionReceipt.type : <code>string</code>
441
+ A hexadecimal string representing the transaction type. 0x0 is DefaultFeeTxType.
442
+
443
+ **Kind**: instance property of [<code>TransactionReceipt</code>](#module_quantum-coin-js-sdk..TransactionReceipt)
444
+ **Access**: public
445
+ <a name="module_quantum-coin-js-sdk..TransactionDetails"></a>
446
+
447
+ ### quantum-coin-js-sdk~TransactionDetails
448
+ This class represents a result from invoking the getTransactionDetails function. You should consider the transaction as succeeded only if the status field of the receipt object is 0x1 (success).
449
+
450
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
451
+ **Access**: public
452
+
453
+ * [~TransactionDetails](#module_quantum-coin-js-sdk..TransactionDetails)
454
+ * [.blockHash](#module_quantum-coin-js-sdk..TransactionDetails+blockHash) : <code>string</code>
455
+ * [.blockNumber](#module_quantum-coin-js-sdk..TransactionDetails+blockNumber) : <code>number</code>
456
+ * [.from](#module_quantum-coin-js-sdk..TransactionDetails+from) : <code>string</code>
457
+ * [.gas](#module_quantum-coin-js-sdk..TransactionDetails+gas) : <code>string</code>
458
+ * [.gasPrice](#module_quantum-coin-js-sdk..TransactionDetails+gasPrice) : <code>string</code>
459
+ * [.hash](#module_quantum-coin-js-sdk..TransactionDetails+hash) : <code>string</code>
460
+ * [.input](#module_quantum-coin-js-sdk..TransactionDetails+input) : <code>string</code>
461
+ * [.nonce](#module_quantum-coin-js-sdk..TransactionDetails+nonce) : <code>number</code>
462
+ * [.to](#module_quantum-coin-js-sdk..TransactionDetails+to) : <code>string</code>
463
+ * [.value](#module_quantum-coin-js-sdk..TransactionDetails+value) : <code>string</code>
464
+ * [.receipt](#module_quantum-coin-js-sdk..TransactionDetails+receipt) : <code>TransactionReceipt</code>
465
+
466
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+blockHash"></a>
467
+
468
+ #### transactionDetails.blockHash : <code>string</code>
469
+ A hexadecimal string representing the hash of the block that registered the transaction. This field can be null if the transaction was not registered in the blockchain.
470
+
471
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
472
+ **Access**: public
473
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+blockNumber"></a>
474
+
475
+ #### transactionDetails.blockNumber : <code>number</code>
476
+ The number of the block that registered the transaction. This field can be null if the transaction was not registered in the blockchain.
477
+
478
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
479
+ **Access**: public
480
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+from"></a>
481
+
482
+ #### transactionDetails.from : <code>string</code>
483
+ A 66 character hexadecimal string representing the address the transaction is sent from.
484
+
485
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
486
+ **Access**: public
487
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+gas"></a>
488
+
489
+ #### transactionDetails.gas : <code>string</code>
490
+ A hexadecimal string representing the gas provided for the transaction execution.
491
+
492
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
493
+ **Access**: public
494
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+gasPrice"></a>
495
+
496
+ #### transactionDetails.gasPrice : <code>string</code>
497
+ A hexadecimal string representing the gasPrice used for each paid gas, in Wei.
498
+
499
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
500
+ **Access**: public
501
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+hash"></a>
502
+
503
+ #### transactionDetails.hash : <code>string</code>
504
+ A hexadecimal string representing the hash of the transaction.
505
+
506
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
507
+ **Access**: public
508
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+input"></a>
509
+
510
+ #### transactionDetails.input : <code>string</code>
511
+ A hexadecimal string representing the compiled code of a contract OR the hash of the invoked method signature and encoded parameters.
512
+
513
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
514
+ **Access**: public
515
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+nonce"></a>
516
+
517
+ #### transactionDetails.nonce : <code>number</code>
518
+ A monotonically increasing number representing the nonce of the account. After each transaction from the account that gets registered in the blockchain, the nonce increases by 1.
519
+
520
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
521
+ **Access**: public
522
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+to"></a>
523
+
524
+ #### transactionDetails.to : <code>string</code>
525
+ A 66 character hexadecimal string representing address the transaction is directed to.
526
+
527
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
528
+ **Access**: public
529
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+value"></a>
530
+
531
+ #### transactionDetails.value : <code>string</code>
532
+ A hexadecimal string representing the value sent with this transaction. The value can be 0 for smart contract transactions, since it only represents the number of coins sent.
533
+
534
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
535
+ **Access**: public
536
+ <a name="module_quantum-coin-js-sdk..TransactionDetails+receipt"></a>
537
+
538
+ #### transactionDetails.receipt : <code>TransactionReceipt</code>
539
+ The receipt of the transaction. This field will be null while the transaction is pending (not yet registered in the blockchain).
540
+
541
+ **Kind**: instance property of [<code>TransactionDetails</code>](#module_quantum-coin-js-sdk..TransactionDetails)
542
+ **Access**: public
543
+ <a name="module_quantum-coin-js-sdk..TransactionDetailsResult"></a>
544
+
545
+ ### quantum-coin-js-sdk~TransactionDetailsResult
546
+ This class represents a result from invoking the getTransactionDetails function. If transactions get discarded by the blockchain, for reasons such as due to lower than minimum gas fees or invalid nonce, the resultCode will always contain a non-zero value (failure).
547
+
548
+ **Kind**: inner class of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
549
+ **Access**: public
550
+
551
+ * [~TransactionDetailsResult](#module_quantum-coin-js-sdk..TransactionDetailsResult)
552
+ * [.resultCode](#module_quantum-coin-js-sdk..TransactionDetailsResult+resultCode) : <code>number</code>
553
+ * [.transactionDetails](#module_quantum-coin-js-sdk..TransactionDetailsResult+transactionDetails) : <code>TransactionDetails</code>
554
+ * [.response](#module_quantum-coin-js-sdk..TransactionDetailsResult+response) : <code>Object</code>
555
+
556
+ <a name="module_quantum-coin-js-sdk..TransactionDetailsResult+resultCode"></a>
557
+
558
+ #### transactionDetailsResult.resultCode : <code>number</code>
559
+ Represents the result of the operation. A value of 0 represents that the operation succeeded. Any other value indicates the operation failed. See the result code section for more details.
560
+
561
+ **Kind**: instance property of [<code>TransactionDetailsResult</code>](#module_quantum-coin-js-sdk..TransactionDetailsResult)
562
+ **Access**: public
563
+ <a name="module_quantum-coin-js-sdk..TransactionDetailsResult+transactionDetails"></a>
564
+
565
+ #### transactionDetailsResult.transactionDetails : <code>TransactionDetails</code>
566
+ An object of type TransactionDetails representing the block. This value is null if the value of resultCode is not 0.
567
+
568
+ **Kind**: instance property of [<code>TransactionDetailsResult</code>](#module_quantum-coin-js-sdk..TransactionDetailsResult)
569
+ **Access**: public
570
+ <a name="module_quantum-coin-js-sdk..TransactionDetailsResult+response"></a>
571
+
572
+ #### transactionDetailsResult.response : <code>Object</code>
573
+ An object of representing the raw Response returned by the service. For details, see https://developer.mozilla.org/en-US/docs/Web/API/Response. This value can be null if the value of resultCode is not 0.
574
+
575
+ **Kind**: instance property of [<code>TransactionDetailsResult</code>](#module_quantum-coin-js-sdk..TransactionDetailsResult)
576
+ **Access**: public
577
+ <a name="module_quantum-coin-js-sdk..initialize"></a>
578
+
579
+ ### quantum-coin-js-sdk~initialize(clientConfig) ⇒ <code>Promise.&lt;boolean&gt;</code>
580
+ The initialize function has to be called before attempting to invoke any other function. This function should be called only once.
581
+
582
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
583
+ **Returns**: <code>Promise.&lt;boolean&gt;</code> - Returns a promise of type boolean; true if the initialization succeeded, else false.
584
+
585
+ | Param | Type | Description |
586
+ | --- | --- | --- |
587
+ | clientConfig | <code>Config</code> | A configuration represented by the Config class |
588
+
589
+ <a name="module_quantum-coin-js-sdk..isAddressValid"></a>
590
+
591
+ ### quantum-coin-js-sdk~isAddressValid(address) ⇒ <code>boolean</code>
592
+ The isAddressValid function validates whether an address is valid or not. An address is of length 66 characters including 0x.
593
+
594
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
595
+ **Returns**: <code>boolean</code> - Returns true if the address validation succeeded, else returns false.
596
+
597
+ | Param | Type | Description |
598
+ | --- | --- | --- |
599
+ | address | <code>string</code> | A string representing the address to validate. |
600
+
601
+ <a name="module_quantum-coin-js-sdk..newWallet"></a>
602
+
603
+ ### quantum-coin-js-sdk~newWallet() ⇒ <code>Wallet</code>
604
+ The newWallet function creates a new Wallet.
605
+
606
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
607
+ **Returns**: <code>Wallet</code> - Returns a Wallet object.
608
+ <a name="module_quantum-coin-js-sdk..verifyWallet"></a>
609
+
610
+ ### quantum-coin-js-sdk~verifyWallet(wallet) ⇒ <code>boolean</code>
611
+ The verifyWallet function verifies whether a Wallet is valid or not. To mitigate spoofing and other attachs, it is highly recommended to verify a wallet, especially if it is from an untrusted source.
612
+
613
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
614
+ **Returns**: <code>boolean</code> - Returns true if the Wallet verification succeeded, else returns false.
615
+
616
+ | Param | Type | Description |
617
+ | --- | --- | --- |
618
+ | wallet | <code>Wallet</code> | A Wallet object representing the wallet to verify. |
619
+
620
+ <a name="module_quantum-coin-js-sdk..serializeWallet"></a>
621
+
622
+ ### quantum-coin-js-sdk~serializeWallet(wallet) ⇒ <code>string</code>
623
+ The serializeWallet function serializes a Wallet object to a JSON string. You should encrypt the string before saving it to disk or a database.
624
+
625
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
626
+ **Returns**: <code>string</code> - Returns the Wallet in JSON string format. If the wallet is invalid, null is returned.
627
+
628
+ | Param | Type | Description |
629
+ | --- | --- | --- |
630
+ | wallet | <code>Wallet</code> | A Wallet object representing the wallet to serialize. |
631
+
632
+ <a name="module_quantum-coin-js-sdk..deserializeWallet"></a>
633
+
634
+ ### quantum-coin-js-sdk~deserializeWallet(walletJson) ⇒ <code>Wallet</code>
635
+ The deserializeWallet function creates a Wallet object from a JSON string.
636
+
637
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
638
+ **Returns**: <code>Wallet</code> - Returns the Wallet corresponding to the walletJson. If the wallet is invalid, null is returned.
639
+
640
+ | Param | Type | Description |
641
+ | --- | --- | --- |
642
+ | walletJson | <code>string</code> | A Wallet object representing the wallet to deserialize. |
643
+
644
+ <a name="module_quantum-coin-js-sdk..postTransaction"></a>
645
+
646
+ ### quantum-coin-js-sdk~postTransaction(txnData) ⇒ <code>Promise.&lt;SendResult&gt;</code>
647
+ The postTransaction function posts a signed transaction to the blockchain.
648
+
649
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
650
+ **Returns**: <code>Promise.&lt;SendResult&gt;</code> - Returns a promise of type SendResult.
651
+
652
+ | Param | Type | Description |
653
+ | --- | --- | --- |
654
+ | txnData | <code>string</code> | A signed transaction string returned by the signSendCoinTransaction function. |
655
+
656
+ <a name="module_quantum-coin-js-sdk..getLatestBlockDetails"></a>
657
+
658
+ ### quantum-coin-js-sdk~getLatestBlockDetails() ⇒ <code>Promise.&lt;BlockDetailsResult&gt;</code>
659
+ The getLatestBlockDetails function returns details of the latest block of the blockchain.
660
+
661
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
662
+ **Returns**: <code>Promise.&lt;BlockDetailsResult&gt;</code> - Returns a promise of an object of type BlockDetailsResult.
663
+ <a name="module_quantum-coin-js-sdk..getAccountDetails"></a>
664
+
665
+ ### quantum-coin-js-sdk~getAccountDetails(address) ⇒ <code>Promise.&lt;AccountDetailsResult&gt;</code>
666
+ The getAccountDetails function returns details of an account corresponding to the address.
667
+
668
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
669
+ **Returns**: <code>Promise.&lt;AccountDetailsResult&gt;</code> - Returns a promise of type AccountDetailsResult.
670
+
671
+ | Param | Type | Description |
672
+ | --- | --- | --- |
673
+ | address | <code>string</code> | The address of the account of which the details have to be retrieved. |
674
+
675
+ <a name="module_quantum-coin-js-sdk..getTransactionDetails"></a>
676
+
677
+ ### quantum-coin-js-sdk~getTransactionDetails(txnHash) ⇒ <code>Promise.&lt;TransactionDetailsResult&gt;</code>
678
+ The getTransactionDetails function returns details of a transaction posted to the blockchain. Transactions may take a while to get registered in the blockchain. Some transactions that have lower balance than the minimum required for gas fees may be discarded.
679
+
680
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
681
+ **Returns**: <code>Promise.&lt;TransactionDetailsResult&gt;</code> - Returns a promise of type type TransactionDetailsResult.
682
+
683
+ | Param | Type | Description |
684
+ | --- | --- | --- |
685
+ | txnHash | <code>string</code> | The hash of the transaction to retrieve. |
686
+
687
+ <a name="module_quantum-coin-js-sdk..signSendCoinTransaction"></a>
688
+
689
+ ### quantum-coin-js-sdk~signSendCoinTransaction(wallet, toAddress, coinsInWei, nonce) ⇒ <code>SignResult</code>
690
+ The signSendCoinTransaction function returns a signed transaction.
691
+
692
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
693
+ **Returns**: <code>SignResult</code> - Returns a promise of type SignResult.
694
+
695
+ | Param | Type | Description |
696
+ | --- | --- | --- |
697
+ | wallet | <code>Wallet</code> | A Wallet object from which the transaction has to be sent. The address corresponding to the Wallet should have enough coins to cover gas fees as well. A minimum of 1000 coins (1000000000000000000000 wei) are required for gas fees. |
698
+ | toAddress | <code>string</code> | The address to which the coins should be sent. |
699
+ | coinsInWei | <code>string</code> | The string representing the number of coins (in wei) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei |
700
+ | nonce | <code>number</code> | The nonce of the account retrieved by invoking the getAccountDetails function. You have to carefully manage state of the nonce to avoid sending the coins multiple times, such as when retrying sendCoins after a network error. |
701
+
702
+ <a name="module_quantum-coin-js-sdk..sendCoins"></a>
703
+
704
+ ### quantum-coin-js-sdk~sendCoins(wallet, toAddress, coinsInWei, nonce) ⇒ <code>Promise.&lt;SendResult&gt;</code>
705
+ The sendCoins function posts a send-coin transaction to the blockchain.
706
+
707
+ **Kind**: inner method of [<code>quantum-coin-js-sdk</code>](#module_quantum-coin-js-sdk)
708
+ **Returns**: <code>Promise.&lt;SendResult&gt;</code> - Returns a promise of type SendResult.
709
+
710
+ | Param | Type | Description |
711
+ | --- | --- | --- |
712
+ | wallet | <code>Wallet</code> | A Wallet object from which the transaction has to be sent. The address corresponding to the Wallet should have enough coins to cover gas fees as well. A minimum of 1000 coins (1000000000000000000000 wei) are required for gas fees. |
713
+ | toAddress | <code>string</code> | The address to which the coins should be sent. |
714
+ | coinsInWei | <code>string</code> | The string representing the number of coins (in wei) to send. To convert between ethers and wei, see https://docs.ethers.org/v4/api-utils.html#ether-strings-and-wei |
715
+ | nonce | <code>number</code> | The nonce of the account retrieved by invoking the getAccountDetails function. You have to carefully manage state of the nonce to avoid sending the coins multiple times, such as when retrying sendCoins after a network error. |
716
+