# all files / packages/web3-eth-abi/src/types/ formatters.js

98.31% Statements 58/59
75% Branches 9/12
100% Functions 14/14
98.31% Lines 58/59

    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

    1×
    1×
    1×
    1×

    1×
    263×

    1×
    263×
    200×

    263×

    1×
    18×
    18×
    18×
    18×

    1×
    10×
    10×
    10×
    10×
    10×

    1×
    17×
    17×
    17×
    17×
    17×

    1×
    15×
    15×

    1×
    56×

    1×
    56×

    56×
    2×

    54×

    1×
    100×
    100×

    1×
    19×

    1×
    16×
    16×
    16×

    1×
    16×
    16×

    1×
    12×
    12×
    12×
    12×

    1×
    44×
    44×

    1×

     /*
        This file is part of web3.js.

        web3.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.

        web3.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 web3.js.  If not, see <http://www.gnu.org/licenses/>.
    */
    /**
     * @file formatters.js
     * @author Marek Kotewicz <marek@ethcore.io>
     * @author Fabian Vogelsteller <fabian@frozeman.de>
     * @date 2017
     */

    var _ = require('underscore');
    var utils = require('web3-utils');
    var BN = require('bn.js');
    var SolidityParam = require('./param');

    /**
     * Takes and input transforms it into BN and if it is negative value, into two's complement
     *
     * @method toTwosComplement
     * @param {Number|String|BN} number
     * @return {String}
     */
    var toTwosComplement = function (number) {
        return utils.toBN(number).toTwos(256).toString(16, 64);
    };

    /**
     * Formats input value to byte representation of int
     * If value is negative, return it's two's complement
     * If the value is floating point, round it down
     *
     * @method formatInputInt
     * @param {String|Number|BN} value that needs to be formatted
     * @returns {SolidityParam}
     */
    var formatInputInt = function (value) {
        if(_.isNumber(value)) {
            value = Math.trunc(value);
        }
        return new SolidityParam(toTwosComplement(value));
    };

    /**
     * Formats input bytes
     *
     * @method formatInputBytes
     * @param {String} value
     * @returns {SolidityParam}
     */
    var formatInputBytes = function (value) {
        var result = value.replace(/^0x/i,'');
        var l = Math.floor((result.length + 63) / 64);
        result = utils.padRight(result, l * 64);
        return new SolidityParam(result);
    };

    /**
     * Formats input bytes
     *
     * @method formatDynamicInputBytes
     * @param {String} value
     * @returns {SolidityParam}
     */
    var formatInputDynamicBytes = function (value) {
        var result = value.replace(/^0x/i,'');
        var length = result.length / 2;
        var l = Math.floor((result.length + 63) / 64);
        result = utils.padRight(result, l * 64);
        return new SolidityParam(formatInputInt(length).value + result);
    };

    /**
     * Formats input value to byte representation of string
     *
     * @method formatInputString
     * @param {String}
     * @returns {SolidityParam}
     */
    var formatInputString = function (value) {
        var result = utils.utf8ToHex(value).replace(/^0x/i,'');
        var length = result.length / 2;
        var l = Math.floor((result.length + 63) / 64);
        result = utils.padRight(result, l * 64);
        return new SolidityParam(formatInputInt(length).value + result);
    };

    /**
     * Formats input value to byte representation of bool
     *
     * @method formatInputBool
     * @param {Boolean}
     * @returns {SolidityParam}
     */
    var formatInputBool = function (value) {
        var result = '000000000000000000000000000000000000000000000000000000000000000' + (value ?  '1' : '0');
        return new SolidityParam(result);
    };

    /**
     * Check if input value is negative
     *
     * @method signedIsNegative
     * @param {String} value is hex format
     * @returns {Boolean} true if it is negative, otherwise false
     */
    var signedIsNegative = function (value) {
        return (new BN(value.substr(0, 1), 16).toString(2).substr(0, 1)) === '1';
    };

    /**
     * Formats right-aligned output bytes to int
     *
     * @method formatOutputInt
     * @param {SolidityParam} param
     * @returns {BN} right-aligned output bytes formatted to big number
     */
    var formatOutputInt = function (param) {
        var value = param.staticPart() || "0";

        // check if it's negative number
        // it it is, return two's complement
        if (signedIsNegative(value)) {
            return new BN(value, 16).fromTwos(256).toString(10);
        }
        return new BN(value, 16).toString(10);
    };

    /**
     * Formats right-aligned output bytes to uint
     *
     * @method formatOutputUInt
     * @param {SolidityParam} param
     * @returns {BN} right-aligned output bytes formatted to uint
     */
    var formatOutputUInt = function (param) {
        var value = param.staticPart() || "0";
        return new BN(value, 16).toString(10);
    };

    /**
     * Should be used to format output bool
     *
     * @method formatOutputBool
     * @param {SolidityParam} param
     * @returns {Boolean} right-aligned input bytes formatted to bool
     */
    var formatOutputBool = function (param) {
        return (param.staticPart() === '0000000000000000000000000000000000000000000000000000000000000001');
    };

    /**
     * Should be used to format output bytes
     *
     * @method formatOutputBytes
     * @param {SolidityParam} param left-aligned hex representation of string
     * @param {String} name type name
     * @returns {String} hex string
     */
    var formatOutputBytes = function (param, name) {
        var matches = name.match(/^bytes([0-9]*)/);
        var size = parseInt(matches[1]);
        return '0x' + param.staticPart().slice(0, 2 * size);
    };

    /**
     * Should be used to format output bytes
     *
     * @method formatOutputDynamicBytes
     * @param {SolidityParam} param left-aligned hex representation of string
     * @returns {String} hex string
     */
    var formatOutputDynamicBytes = function (param) {
        var length = (new BN(param.dynamicPart().slice(0, 64), 16)).toNumber() * 2;
        return '0x' + param.dynamicPart().substr(64, length);
    };

    /**
     * Should be used to format output string
     *
     * @method formatOutputString
     * @param {SolidityParam} left-aligned hex representation of string
     * @returns {String} ascii string
     */
    var formatOutputString = function (param) {
        var hex = param.dynamicPart().slice(0, 64);
        Eif(hex) {
            var length = (new BN(hex, 16)).toNumber() * 2;
            return utils.hexToUtf8('0x'+ param.dynamicPart().substr(64, length).replace(/^0x/i, ''));
        } else {
            return "ERROR: Strings are not yet supported as return values";
        }
    };

    /**
     * Should be used to format output address
     *
     * @method formatOutputAddress
     * @param {Object} param right-aligned input bytes
     * @returns {String} address
     */
    var formatOutputAddress = function (param) {
        var value = param.staticPart();
        return utils.toChecksumAddress("0x" + value.slice(value.length - 40, value.length));
    };

    module.exports = {
        formatInputInt: formatInputInt,
        formatInputBytes: formatInputBytes,
        formatInputDynamicBytes: formatInputDynamicBytes,
        formatInputString: formatInputString,
        formatInputBool: formatInputBool,
        formatOutputInt: formatOutputInt,
        formatOutputUInt: formatOutputUInt,
        formatOutputBool: formatOutputBool,
        formatOutputBytes: formatOutputBytes,
        formatOutputDynamicBytes: formatOutputDynamicBytes,
        formatOutputString: formatOutputString,
        formatOutputAddress: formatOutputAddress,
        toTwosComplement: toTwosComplement
    };