susyweb

<!doctype html> <html lang="en"> <head> <title>Code coverage report for packages/susyweb-core-method/src/index.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../../../prettify.css" /> <link rel="stylesheet" href="../../../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../../../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../../../index.html">all files</a> / <a href="index.html">packages/susyweb-core-method/src/</a> index.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 94.57% Statements 174/184 </div> <div class='fl pad1y space-right2'> 90.14% Branches 128/142 </div> <div class='fl pad1y space-right2'> 96.43% Functions 27/28 </div> <div class='fl pad1y space-right2'> 94.57% Lines 174/184 </div> </div> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480</td><td class="line-coverage quiet">                                                  1× 1× 1× 1×   1× 1×   1×   20210× 2×     20208× 20208× 20208× 20208× 20208× 20208× 20208×     1× 20195×   20195× 10156×                     1× 439×                   1× 438× 108×                     1× 433× 2×                     1× 437× 56×     381× 514×                     1× 428×   428× 41× 50×     387×                     1× 435× 435× 435× 429×   429×           429× 8×     429×     1× 20180× 20180× 20180× 20180× 951× 951×   19229×       1× 43×                             43× 179×   179× 19×   4×           179×                   179× 133×       46× 4×       46×   25×   25× 25×   25× 1× 1×       46×         46×   7× 2× 2× 2×     5×   5×         5× 3×     3× 1×   2×         2×     5× 5× 5×   5×       44×         46×   15×   15× 15×                 15× 14× 14×   15×           133× 2× 2× 2×     133×                       43× 36×   7×         1× 10×     10× 2×     8× 2×       6×     10×     1× 20195×         20195× 429× 429×         423× 419×     419× 416× 97×     3× 3×     3× 3×       416×   373× 373×         43×   43×   43×           423×   423× 22×     22× 6× 6×       6× 6×   6×     6× 6×   6×         16× 4× 4×     4× 4×   4× 2×     4× 4×             413×         423×   2× 2× 2×   2×       421×       423×     20195× 20195×                 1× 6× 6× 6×     1×  </td><td class="text"><pre class="prettyprint lang-js">/* This file is part of susyweb.js.   susyweb.js is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.   susyweb.js is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MSRCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.   You should have received a copy of the GNU Lesser General Public License along with susyweb.js. If not, see <http://www.gnu.org/licenses/>. */ /** * @file index.js * @author Fabian Vogelsteller <fabian@ethereum.org> * @author Marek Kotewicz <marek@sofcore.io> * @date 2017 */   "use strict";   var _ = require('underscore'); var errors = require('susyweb-core-helpers').errors; var utils = require('susyweb-utils'); var promiEvent = require('susyweb-core-promiEvent');   var TIMEOUTBLOCK = 50; var CONFIRMATIONBLOCKS = 24;   var Method = function Method(options) {   if(!options.call || !options.name) { throw new Error('When creating a method you need to provide at least the "name" and "call" property.'); }   this.name = options.name; this.call = options.call; this.params = options.params || 0; this.inputFormatter = options.inputFormatter; this.outputFormatter = options.outputFormatter; this.transformPayload = options.transformPayload; this.requestManager = null; };   Method.prototype.setRequestManager = function (rm, sof) { this.requestManager = rm;   if (sof) { this.sof = sof; } };   /** * Should be used to determine name of the jsonrpc method based on arguments * * @method getCall * @param {Array} arguments * @return {String} name of jsonrpc method */ Method.prototype.getCall = function (args) { return _.isFunction(this.call) ? this.call(args) : this.call; };   /** * Should be used to extract callback from array of arguments. Modifies input param * * @method extractCallback * @param {Array} arguments * @return {Function|Null} callback, if exists */ Method.prototype.extractCallback = function (args) { if (_.isFunction(args[args.length - 1])) { return args.pop(); // modify the args array! } };   /** * Should be called to check if the number of arguments is correct * * @method validateArgs * @param {Array} arguments * @throws {Error} if it is not */ Method.prototype.validateArgs = function (args) { if (args.length !== this.params) { throw errors.InvalidNumberOfParams(args.length, this.params, this.name); } };   /** * Should be called to format input args of method * * @method formatInput * @param {Array} * @return {Array} */ Method.prototype.formatInput = function (args) { if (!this.inputFormatter) { return args; }   return this.inputFormatter.map(function (formatter, index) { return formatter ? formatter(args[index]) : args[index]; }); };   /** * Should be called to format output(result) of method * * @method formatOutput * @param {Object} * @return {Object} */ Method.prototype.formatOutput = function (result) { var _this = this;   if(_.isArray(result)) { return result.map(function(res){ return _this.outputFormatter && res ? _this.outputFormatter(res) : res; }); } else { return this.outputFormatter && result ? this.outputFormatter(result) : result; } };   /** * Should create payload from given input args * * @method toPayload * @param {Array} args * @return {Object} */ Method.prototype.toPayload = function (args) { var call = this.getCall(args); var callback = this.extractCallback(args); var params = this.formatInput(args); this.validateArgs(params);   var payload = { method: call, params: params, callback: callback };   if (this.transformPayload) { payload = this.transformPayload(payload); }   return payload; };   Method.prototype.attachToObject = function (obj) { var func = this.buildCall(); func.call = this.call; // TODO!!! that's ugly. filter.js uses it var name = this.name.split('.'); if (name.length > 1) { obj[name[0]] = obj[name[0]] || {}; obj[name[0]][name[1]] = func; } else { obj[name[0]] = func; } };   Method.prototype._confirmTransaction = function (defer, result, payload, extraFormatters) { var method = this, promiseResolved = false, canUnsubscribe = true, timeoutCount = 0, confirmationCount = 0, intervalId = null, gasProvided = (_.isObject(payload.params[0]) && payload.params[0].gas) ? payload.params[0].gas : null, isContractDeployment = _.isObject(payload.params[0]) && payload.params[0].data && payload.params[0].from && !payload.params[0].to;       // fire "receipt" and confirmation events and resolve after var checkConfirmation = function (err, block, sub) { Eif (!err) { // create fake unsubscribe if (!sub) { sub = { unsubscribe: function () { clearInterval(intervalId); } }; }     method.sof.getTransactionReceipt(result) // catch error from requesting receipt .catch(function (err) { sub.unsubscribe(); promiseResolved = true; utils._fireError({message: 'Failed to check for transaction receipt:', data: err}, defer.eventEmitter, defer.reject); }) // if CONFIRMATION listener exists check for confirmations, by setting canUnsubscribe = false .then(function(receipt) {   if (!receipt) { throw new Error('Receipt is "null"'); }   // apply extra formatters if (extraFormatters && extraFormatters.receiptFormatter) { receipt = extraFormatters.receiptFormatter(receipt); }   // check if confirmation listener exists if (defer.eventEmitter.listeners('confirmation').length > 0) {   defer.eventEmitter.emit('confirmation', confirmationCount, receipt);   canUnsubscribe = false; confirmationCount++;   if (confirmationCount === CONFIRMATIONBLOCKS + 1) { // add 1 so we account for conf 0 sub.unsubscribe(); defer.eventEmitter.removeAllListeners(); } }   return receipt; }) // CHECK for CONTRACT DEPLOYMENT .then(function(receipt) {   if (isContractDeployment && !promiseResolved) {   if (!receipt.contractAddress) { promiseResolved = true; utils._fireError(new Error('The transaction receipt didn\'t contain a contract address.'), defer.eventEmitter, defer.reject); return; }   method.sof.getCode(receipt.contractAddress, function (e, code) {   Iif (!code) { return; }     if (code.length > 2) { defer.eventEmitter.emit('receipt', receipt);   // if contract, return instance instead of receipt if (extraFormatters && extraFormatters.contractDeployFormatter) { defer.resolve(extraFormatters.contractDeployFormatter(receipt)); } else { defer.resolve(receipt); }     } else { utils._fireError(new Error('The contract code couldn\'t be stored, please check your gas limit.'), defer.eventEmitter, defer.reject); }   Eif (canUnsubscribe) { sub.unsubscribe(); defer.eventEmitter.removeAllListeners(); } promiseResolved = true; }); }   return receipt; }) // CHECK for normal tx check for receipt only .then(function(receipt) {   if (!isContractDeployment && !promiseResolved) {   Eif(!receipt.outOfGas && (!gasProvided || gasProvided !== receipt.gasUsed)) { defer.eventEmitter.emit('receipt', receipt); defer.resolve(receipt);   } else { if(receipt) { receipt = JSON.stringify(receipt, null, 2); } utils._fireError(new Error("Transaction ran out of gas. Please provide more gas:\n"+ receipt), defer.eventEmitter, defer.reject); }   if (canUnsubscribe) { sub.unsubscribe(); defer.eventEmitter.removeAllListeners(); } promiseResolved = true; }   }) // time out the transaction if not mined after 50 blocks .catch(function () { if (timeoutCount >= TIMEOUTBLOCK) { sub.unsubscribe(); promiseResolved = true; utils._fireError(new Error('Transaction was not mined within 50 blocks, please make sure your transaction was properly send. Be aware that it might still be mined!'), defer.eventEmitter, defer.reject); }   timeoutCount++; });     } else { sub.unsubscribe(); promiseResolved = true; utils._fireError({message: 'Failed to subscribe to new newBlockHeaders to confirm the transactions receipt. Are you using HttpProvider? Please switch to Websockets.', data: err}, defer.eventEmitter, defer.reject); } };   // if provider allows PUB/SUB if (_.isFunction(this.requestManager.provider.on)) { method.sof.subscribe('newBlockHeaders', checkConfirmation); } else { intervalId = setInterval(checkConfirmation, 1000); } };     var getWallet = function(from, accounts) { var wallet = null;   // is index given if (_.isNumber(from)) { wallet = accounts.wallet[from];   // is account given } else if (_.isObject(from) && from.address && from.privateKey) { wallet = from;   // search in wallet for address } else { wallet = accounts.wallet[from.toLowerCase()]; }   return wallet; };   Method.prototype.buildCall = function() { var method = this, call = (_.isString(method.call)) ? method.call.toLowerCase() : Method.call, isSendTx = (call === 'sof_sendtransaction' || call === 'sof_sendrawtransaction');   // actual send function var send = function () { var extraFromatters = this; var defer = promiEvent(!isSendTx), payload = method.toPayload(Array.prototype.slice.call(arguments));     // CALLBACK function var sendTxCallback = function (err, result) { result = method.formatOutput(result);     if (!err) { if (payload.callback) { payload.callback(null, result); } } else { Eif(err.error) { err = err.error; }   utils._fireError(err, defer.eventEmitter, defer.reject, payload.callback); return; }   // return PROMISE if (!isSendTx) {   Eif (!err) { defer.resolve(result);   }   // return PROMIEVENT } else Eif (method.sof) {   defer.eventEmitter.emit('transactionHash', result);   method._confirmTransaction(defer, result, payload, extraFromatters); }   };     var sendRequest = function(payload, method) {   if (method && method.sof && method.sof.accounts && method.sof.accounts.wallet.length) { var wallet;   // SOF_SENDTRANSACTION if (payload.method.toLowerCase() === 'sof_sendtransaction') { var tx = payload.params[0]; wallet = getWallet((_.isObject(tx)) ? tx.from : null, method.sof.accounts);     // If wallet was found, sign tx, and send using sendRawTransaction Eif (wallet && wallet.privateKey) { delete tx.from;   return method.sof.accounts.signTransaction(tx, wallet.privateKey) .then(function(sign){   payload.method = 'sof_sendRawTransaction'; payload.params = [sign.rawTransaction];   method.requestManager.send(payload, sendTxCallback); }); }   // SOF_SIGN } else if (payload.method.toLowerCase() === 'sof_sign') { var data = payload.params[1]; wallet = getWallet(payload.params[0], method.sof.accounts);   // If wallet was found, sign tx, and send using sendRawTransaction Eif (wallet && wallet.privateKey) { var sign = method.sof.accounts.sign(data, wallet.privateKey);   if (payload.callback) { payload.callback(null, sign.signature); }   defer.resolve(sign.signature); return; }     } }   return method.requestManager.send(payload, sendTxCallback); };     // Send the actual transaction if(isSendTx && method.sof && _.isObject(payload.params[0]) && !payload.params[0].gasPrice) {   method.sof.getGasPrice(function (err, gasPrice) { Eif (gasPrice) { payload.params[0].gasPrice = utils.numberToHex(gasPrice); } sendRequest(payload, method); });   } else { sendRequest(payload, method); }     return defer.eventEmitter; };   send.request = this.request.bind(this); return send; };   /** * Should be called to create the pure JSONRPC request which can be used in a batch request * * @method request * @return {Object} jsonrpc request */ Method.prototype.request = function () { var payload = this.toPayload(Array.prototype.slice.call(arguments)); payload.format = this.formatOutput.bind(this); return payload; };   module.exports = Method;  </pre></td></tr> </table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Sat Jul 22 2017 12:47:05 GMT+0200 (CEST) </div> </div> <script src="../../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../../sorter.js"></script> </body> </html>