Skip to content

Commit ee06bc5

Browse files
sebssebs
committed
Updates
1 parent db306e8 commit ee06bc5

11 files changed

+2130
-157
lines changed

‎index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-et
9696
<br class="clear">
9797

9898
<footer>
99-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Mon Oct 10 2016 16:25:34 GMT+0200 (CEST)
99+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Mon Oct 10 2016 21:44:43 GMT+0200 (CEST)
100100
</footer>
101101

102102
<script> prettyPrint(); </script>

‎init.js.html

Lines changed: 66 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ <h1 class="page-title">Source: init.js</h1>
138138
proxy: {
139139
/**
140140
* Returns the number of most recent block
141+
* @returns {Promise.&lt;integer>}
141142
*/
142143
eth_blockNumber() {
143144
const module = 'proxy';
@@ -149,6 +150,8 @@ <h1 class="page-title">Source: init.js</h1>
149150
},
150151
/**
151152
* Returns information about a block by block number.
153+
* @param {string} tag - Tag to look up
154+
* @returns {Promise.&lt;integer>}
152155
*/
153156
eth_getBlockByNumber(tag) {
154157
const module = 'proxy';
@@ -161,6 +164,9 @@ <h1 class="page-title">Source: init.js</h1>
161164
},
162165
/**
163166
* Returns information about a uncle by block number.
167+
* @param {string} tag - Tag to look up
168+
* @param {string} index - Index
169+
* @returns {Promise.&lt;object>}
164170
*/
165171
eth_getUncleByBlockNumberAndIndex(tag, index) {
166172
const module = 'proxy';
@@ -172,6 +178,8 @@ <h1 class="page-title">Source: init.js</h1>
172178
},
173179
/**
174180
* Returns the number of transactions in a block from a block matching the given block number
181+
* @param {string} tag - Tag to look up
182+
* @returns {Promise.&lt;object>}
175183
*/
176184
eth_getBlockTransactionCountByNumber(tag) {
177185
const module = 'proxy';
@@ -183,6 +191,8 @@ <h1 class="page-title">Source: init.js</h1>
183191
},
184192
/**
185193
* Returns the information about a transaction requested by transaction hash
194+
* @param {string} hash - Transaction hash
195+
* @returns {Promise.&lt;object>}
186196
*/
187197
eth_getTransactionByHash(hash) {
188198
const module = 'proxy';
@@ -194,6 +204,9 @@ <h1 class="page-title">Source: init.js</h1>
194204
},
195205
/**
196206
* Returns information about a transaction by block number and transaction index position
207+
* @param {string} tag - Tag to look up
208+
* @param {string} index - Index
209+
* @returns {Promise.&lt;object>}
197210
*/
198211
eth_getTransactionByBlockNumberAndIndex(tag, index) {
199212
const module = 'proxy';
@@ -205,6 +218,8 @@ <h1 class="page-title">Source: init.js</h1>
205218
},
206219
/**
207220
* Returns the number of transactions sent from an address
221+
* @param {string} address - Address of the transaction
222+
* @returns {Promise.&lt;object>}
208223
*/
209224
eth_getTransactionCount(address) {
210225
const module = 'proxy';
@@ -216,6 +231,8 @@ <h1 class="page-title">Source: init.js</h1>
216231
},
217232
/**
218233
* Creates new message call transaction or a contract creation for signed transactions
234+
* @param {string} hex - Serialized Message
235+
* @returns {Promise.&lt;object>}
219236
*/
220237
eth_sendRawTransaction(hex) {
221238
const module = 'proxy';
@@ -227,6 +244,8 @@ <h1 class="page-title">Source: init.js</h1>
227244
},
228245
/**
229246
* Returns the receipt of a transaction by transaction hash
247+
* @param {string} txhash - Transaction hash
248+
* @returns {Promise.&lt;object>}
230249
*/
231250
eth_getTransactionReceipt(txhash) {
232251
const module = 'proxy';
@@ -238,6 +257,9 @@ <h1 class="page-title">Source: init.js</h1>
238257
},
239258
/**
240259
* Executes a new message call immediately without creating a transaction on the block chain
260+
* @param {string} to - Address to execute from
261+
* @param {string} tag - Content
262+
* @returns {Promise.&lt;object>}
241263
*/
242264
eth_call(to, tag) {
243265
const module = 'proxy';
@@ -249,6 +271,9 @@ <h1 class="page-title">Source: init.js</h1>
249271
},
250272
/**
251273
* Returns code at a given address
274+
* @param {string} address - Address to get code from
275+
* @param {string} tag - ??
276+
* @returns {Promise.&lt;object>}
252277
*/
253278
eth_getCode(address, tag) {
254279
const module = 'proxy';
@@ -260,6 +285,10 @@ <h1 class="page-title">Source: init.js</h1>
260285
},
261286
/**
262287
* Returns the value from a storage position at a given address.
288+
* @param {string} address - Address to get code from
289+
* @param {string} position - Storage position
290+
* @param {string} tag - ??
291+
* @returns {Promise.&lt;object>}
263292
*/
264293
eth_getStorageAt(address, position, tag) {
265294
const module = 'proxy';
@@ -271,6 +300,7 @@ <h1 class="page-title">Source: init.js</h1>
271300
},
272301
/**
273302
* Returns the current price per gas in wei.
303+
* @returns {Promise.&lt;object>}
274304
*/
275305
eth_gasPrice() {
276306
const module = 'proxy';
@@ -282,6 +312,11 @@ <h1 class="page-title">Source: init.js</h1>
282312
},
283313
/**
284314
* Makes a call or transaction, which won't be added to the blockchain and returns the used gas, which can be used for estimating the used gas
315+
* @param {string} to - Address to get code from
316+
* @param {string} value - Storage position
317+
* @param {string} gasPrice - ??
318+
* @param {string} gas - ??
319+
* @returns {Promise.&lt;object>}
285320
*/
286321
eth_estimateGas(to, value, gasPrice, gas) {
287322
const module = 'proxy';
@@ -298,6 +333,9 @@ <h1 class="page-title">Source: init.js</h1>
298333
stats: {
299334
/**
300335
* Returns the supply of Tokens
336+
* @param {string} tokenname - Name of the Token
337+
* @param {string} contractaddress - Address from token contract
338+
* @returns {Promise.&lt;object>}
301339
*/
302340
tokensupply(tokenname, contractaddress) {
303341
const module = 'stats';
@@ -318,8 +356,10 @@ <h1 class="page-title">Source: init.js</h1>
318356
var query = querystring.stringify(params);
319357
return getRequest(query);
320358
},
359+
321360
/**
322361
* Returns total supply of ether
362+
* @returns {Promise.&lt;integer>}
323363
*/
324364
ethsupply() {
325365
const module = 'stats';
@@ -330,8 +370,9 @@ <h1 class="page-title">Source: init.js</h1>
330370
return getRequest(query);
331371
},
332372

333-
/*
334-
* Returns tthe price of ether now
373+
/**
374+
* Returns the price of ether now
375+
* @returns {Promise.&lt;integer>}
335376
*/
336377
ethprice() {
337378
const module = 'stats';
@@ -348,6 +389,9 @@ <h1 class="page-title">Source: init.js</h1>
348389
block: {
349390
/**
350391
* Find the block reward for a given address and block
392+
* @param {string} address - Address of the block
393+
* @param {string} blockno - Block number
394+
* @returns {Promise.&lt;object>}
351395
*/
352396
getblockreward(address, blockno) {
353397
const module = 'block';
@@ -367,6 +411,8 @@ <h1 class="page-title">Source: init.js</h1>
367411
transaction: {
368412
/**
369413
* returns the status of a specific transaction hash
414+
* @param {string} txhash - Transaction hash
415+
* @returns {Promise.&lt;object>}
370416
*/
371417
getstatus(txhash) {
372418
const module = 'transaction';
@@ -383,6 +429,8 @@ <h1 class="page-title">Source: init.js</h1>
383429
contract: {
384430
/**
385431
* Returns the ABI/Interface of a given contract
432+
* @param {string} address - Contract address
433+
* @returns {Promise.&lt;object>}
386434
*/
387435
getabi(address) {
388436
const module = 'contract';
@@ -400,7 +448,11 @@ <h1 class="page-title">Source: init.js</h1>
400448
*/
401449
account: {
402450
/**
403-
* Returns the amount of Tokens a specific account owns
451+
* Returns the amount of Tokens a specific account owns.
452+
* @param {string} address - Contract address
453+
* @param {string} tokenname - Name of the token
454+
* @param {string} contractaddress - Contract address
455+
* @returns {Promise.&lt;object>}
404456
*/
405457
tokenbalance(address, tokenname, contractaddress){
406458

@@ -429,6 +481,8 @@ <h1 class="page-title">Source: init.js</h1>
429481
},
430482
/**
431483
* Returns the balance of a sepcific account
484+
* @param {string} address - Address
485+
* @returns {Promise.&lt;object>}
432486
*/
433487
balance(address) {
434488
const module = 'account';
@@ -447,6 +501,8 @@ <h1 class="page-title">Source: init.js</h1>
447501
},
448502
/**
449503
* Get a list of internal transactions
504+
* @param {string} txhash - Transaction hash
505+
* @returns {Promise.&lt;object>}
450506
*/
451507
txlistinternal(txhash) {
452508
const module = 'account';
@@ -460,6 +516,11 @@ <h1 class="page-title">Source: init.js</h1>
460516
},
461517
/**
462518
* Get a list of transactions for a specfic address
519+
* @param {string} address - Transaction address
520+
* @param {string} startblock - start looking here
521+
* @param {string} endblock - end looking there
522+
* @param {string} sort - Sort asc/desc
523+
* @returns {Promise.&lt;object>}
463524
*/
464525
txlist(address, startblock, endblock, sort) {
465526
const module = 'account';
@@ -485,6 +546,7 @@ <h1 class="page-title">Source: init.js</h1>
485546
},
486547
/**
487548
* Get a list of blocks that a specific account has mineds
549+
* @param {string} address - Transaction hash
488550
*/
489551
getminedblocks(address) {
490552
const module = 'account';
@@ -513,7 +575,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-et
513575
<br class="clear">
514576

515577
<footer>
516-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Mon Oct 10 2016 16:25:34 GMT+0200 (CEST)
578+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Mon Oct 10 2016 21:44:43 GMT+0200 (CEST)
517579
</footer>
518580

519581
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)