Code coverage report for ethereum.js/lib/solidity/abi.js

Statements: 100% (42 / 42)      Branches: 75% (6 / 8)      Functions: 100% (11 / 11)      Lines: 100% (42 / 42)      Ignored: none     

All files » ethereum.js/lib/solidity/ » abi.js
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                                              1 1 1                   1 83 91   83                     1 47 49     47                     1 20 20 21 21   21 80 80     21 21     21     20                   1 18 18   19 19   19 47     19 19     19     18     1 6 6 3 2   3   3     1              
/*
    This file is part of ethereum.js.
 
    ethereum.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.
 
    ethereum.js is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY 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 ethereum.js.  If not, see <http://www.gnu.org/licenses/>.
*/
/** 
 * @file abi.js
 * @author Marek Kotewicz <marek@ethdev.com>
 * @author Gav Wood <g@ethdev.com>
 * @date 2014
 */
 
var utils = require('../utils/utils');
var coder = require('./coder');
var solUtils = require('./utils');
 
/**
 * Formats input params to bytes
 *
 * @method formatInput
 * @param {Array} abi inputs of method
 * @param {Array} params that will be formatted to bytes
 * @returns bytes representation of input params
 */
var formatInput = function (inputs, params) {
    var i = inputs.map(function (input) {
        return input.type;
    });
    return coder.encodeParams(i, params);
};
 
/** 
 * Formats output bytes back to param list
 *
 * @method formatOutput
 * @param {Array} abi outputs of method
 * @param {String} bytes represention of output
 * @returns {Array} output params
 */
var formatOutput = function (outs, bytes) {
    var o = outs.map(function (out) {
        return out.type;
    });
    
    return coder.decodeParams(o, bytes); 
};
 
/**
 * Should be called to create input parser for contract with given abi
 *
 * @method inputParser
 * @param {Array} contract abi
 * @returns {Object} input parser object for given json abi
 * TODO: refactor creating the parser, do not double logic from contract
 */
var inputParser = function (json) {
    var parser = {};
    json.forEach(function (method) {
        var displayName = utils.extractDisplayName(method.name);
        var typeName = utils.extractTypeName(method.name);
 
        var impl = function () {
            var params = Array.prototype.slice.call(arguments);
            return formatInput(method.inputs, params);
        };
 
        Eif (parser[displayName] === undefined) {
            parser[displayName] = impl;
        }
 
        parser[displayName][typeName] = impl;
    });
 
    return parser;
};
 
/**
 * Should be called to create output parser for contract with given abi
 *
 * @method outputParser
 * @param {Array} contract abi
 * @returns {Object} output parser for given json abi
 */
var outputParser = function (json) {
    var parser = {};
    json.forEach(function (method) {
 
        var displayName = utils.extractDisplayName(method.name);
        var typeName = utils.extractTypeName(method.name);
 
        var impl = function (output) {
            return formatOutput(method.outputs, output);
        };
 
        Eif (parser[displayName] === undefined) {
            parser[displayName] = impl;
        }
 
        parser[displayName][typeName] = impl;
    });
 
    return parser;
};
 
var formatConstructorParams = function (abi, params) {
    var constructor = solUtils.getConstructor(abi, params.length);
    if (!constructor) {
        if (params.length > 0) {
            console.warn("didn't found matching constructor, using default one");
        }
        return '';
    }
    return formatInput(constructor.inputs, params);
};
 
module.exports = {
    inputParser: inputParser,
    outputParser: outputParser,
    formatInput: formatInput,
    formatOutput: formatOutput,
    formatConstructorParams: formatConstructorParams
};