abi string type, fixes #216, #218, #219

lib/solidity/coder.js

@@ -262,6 +262,13 @@ var coder = new SolidityCoder([
         inputFormatter: f.formatInputBytes,
         outputFormatter: f.formatOutputBytes
     }),
+    new SolidityType({
+        name: 'string',
+        match: 'strict',
+        mode: 'bytes',
+        inputFormatter: f.formatInputString,
+        outputFormatter: f.formatOutputString
+    }),
     new SolidityType({
         name: 'real',
         match: 'prefix',

lib/solidity/formatters.js

@@ -43,25 +43,39 @@ var formatInputInt = function (value) {
 };
 
 /**
- * Formats input value to byte representation of string
+ * Formats input bytes
  *
  * @method formatInputBytes
  * @param {String}
  * @returns {SolidityParam}
  */
 var formatInputBytes = function (value) {
-    var result = utils.fromAscii(value, c.ETH_PADDING).substr(2);
+    var result = utils.padRight(utils.toHex(value).substr(2), 64);
     return new SolidityParam(result);
 };
 
+/**
+ * Formats input bytes
+ *
+ * @method formatDynamicInputBytes
+ * @param {String}
+ * @returns {SolidityParam}
+ */
+var formatInputDynamicBytes = function (value) {
+    var value = utils.toHex(value);
+    var result = utils.padRight((value).substr(2), 64);
+    var length = (value.length / 2 - 1) | 0;
+    return new SolidityParam(formatInputInt(length).value + result, 32);
+};
+
 /**
  * Formats input value to byte representation of string
  *
- * @method formatInputDynamicBytes
+ * @method formatInputString
  * @param {String}
  * @returns {SolidityParam}
  */
-var formatInputDynamicBytes = function (value) {
+var formatInputString = function (value) {
     var result = utils.fromAscii(value, c.ETH_PADDING).substr(2);
     return new SolidityParam(formatInputInt(value.length).value + result, 32);
 };
@@ -165,27 +179,38 @@ var formatOutputBool = function (param) {
 };
 
 /**
- * Should be used to format output string
+ * Should be used to format output bytes
  *
  * @method formatOutputBytes
  * @param {SolidityParam} left-aligned hex representation of string
- * @returns {String} ascii string
+ * @returns {String} hex string
  */
 var formatOutputBytes = function (param) {
-    // length might also be important!
+    return '0x' + param.staticPart();
-    return utils.toAscii(param.staticPart());
+};
+
+/**
+ * Should be used to format output bytes
+ *
+ * @method formatOutputDynamicBytes
+ * @param {SolidityParam} left-aligned hex representation of string
+ * @returns {String} hex string
+ */
+var formatOutputDynamicBytes = function (param) {
+    var length = (new BigNumber(param.dynamicPart().slice(0, 64), 16)).toNumber() * 2;
+    return '0x' + param.dynamicPart().substr(64, length);
 };
 
 /**
  * Should be used to format output string
  *
- * @method formatOutputDynamicBytes
+ * @method formatOutputString
  * @param {SolidityParam} left-aligned hex representation of string
  * @returns {String} ascii string
  */
-var formatOutputDynamicBytes = function (param) {
+var formatOutputString = function (param) {
-    // length might also be important!
+    var length = (new BigNumber(param.dynamicPart().slice(0, 64), 16)).toNumber() * 2;
-    return utils.toAscii(param.dynamicPart().slice(64));
+    return utils.toAscii(param.dynamicPart().substr(64, length));
 };
 
 /**
@@ -204,6 +229,7 @@ module.exports = {
     formatInputInt: formatInputInt,
     formatInputBytes: formatInputBytes,
     formatInputDynamicBytes: formatInputDynamicBytes,
+    formatInputString: formatInputString,
     formatInputBool: formatInputBool,
     formatInputReal: formatInputReal,
     formatOutputInt: formatOutputInt,
@@ -213,6 +239,7 @@ module.exports = {
     formatOutputBool: formatOutputBool,
     formatOutputBytes: formatOutputBytes,
     formatOutputDynamicBytes: formatOutputDynamicBytes,
+    formatOutputString: formatOutputString,
     formatOutputAddress: formatOutputAddress
 };
 

lib/utils/utils.js

@@ -67,6 +67,19 @@ var padLeft = function (string, chars, sign) {
     return new Array(chars - string.length + 1).join(sign ? sign : "0") + string;
 };
 
+/**
+ * Should be called to pad string to expected length
+ *
+ * @method padRight
+ * @param {String} string to be padded
+ * @param {Number} characters that result string should have
+ * @param {String} sign, by default 0
+ * @returns {String} right aligned string
+ */
+var padRight = function (string, chars, sign) {
+    return string + (new Array(chars - string.length + 1).join(sign ? sign : "0"));
+};
+
 /** 
  * Should be called to get sting from it's hex representation
  *
@@ -83,10 +96,6 @@ var toAscii = function(hex) {
     }
     for (; i < l; i+=2) {
         var code = parseInt(hex.substr(i, 2), 16);
-        if (code === 0) {
-            break;
-        }
-
         str += String.fromCharCode(code);
     }
 
@@ -461,6 +470,7 @@ var isIBAN = function (iban) {
 
 module.exports = {
     padLeft: padLeft,
+    padRight: padRight,
     toHex: toHex,
     toDecimal: toDecimal,
     fromDecimal: fromDecimal,

test/coder.decodeParam.js

@@ -20,8 +20,19 @@ describe('lib/solidity/coder', function () {
         test({ type: 'int256', expected: new bn(1),         value: '0000000000000000000000000000000000000000000000000000000000000001'});
         test({ type: 'int256', expected: new bn(16),        value: '0000000000000000000000000000000000000000000000000000000000000010'});
         test({ type: 'int256', expected: new bn(-1),        value: 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff'});
-        test({ type: 'bytes32', expected: 'gavofyork',      value: '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ type: 'bytes32', expected: '0x6761766f66796f726b0000000000000000000000000000000000000000000000',      
-        test({ type: 'bytes', expected: 'gavofyork',        value: '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                            value: '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ type: 'bytes', expected: '0x6761766f66796f726b',       
+                                                            value: '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                                   '0000000000000000000000000000000000000000000000000000000000000009' + 
+                                                                   '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ type: 'bytes32', expected: '0x731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b',      
+                                                            value: '731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b'});
+        test({ type: 'bytes', expected: '0x731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b',       
+                                                            value: '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                                   '0000000000000000000000000000000000000000000000000000000000000020' + 
+                                                                   '731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b'});
+        test({ type: 'string', expected: 'gavofyork',       value: '0000000000000000000000000000000000000000000000000000000000000020' +
                                                                    '0000000000000000000000000000000000000000000000000000000000000009' + 
                                                                    '6761766f66796f726b0000000000000000000000000000000000000000000000'});
         test({ type: 'int[]', expected: [],                 value: '0000000000000000000000000000000000000000000000000000000000000020' +
@@ -62,13 +73,13 @@ describe('lib/solidity/coder', function () {
 
 
         test({ types: ['int'], expected: [new bn(1)],       values: '0000000000000000000000000000000000000000000000000000000000000001'});
-        test({ types: ['bytes32', 'int'], expected: ['gavofyork', new bn(5)],
+        test({ types: ['bytes32', 'int'], expected: ['0x6761766f66796f726b0000000000000000000000000000000000000000000000', new bn(5)],
                                                             values: '6761766f66796f726b0000000000000000000000000000000000000000000000' + 
                                                                     '0000000000000000000000000000000000000000000000000000000000000005'});
-        test({ types: ['int', 'bytes32'], expected: [new bn(5), 'gavofyork'],
+        test({ types: ['int', 'bytes32'], expected: [new bn(5), '0x6761766f66796f726b0000000000000000000000000000000000000000000000'],
                                                             values: '0000000000000000000000000000000000000000000000000000000000000005' + 
                                                                     '6761766f66796f726b0000000000000000000000000000000000000000000000'});
-        test({ types: ['int', 'bytes', 'int', 'int', 'int', 'int[]'], expected: [new bn(1), 'gavofyork', new bn(2), new bn(3), new bn(4), 
+        test({ types: ['int', 'string', 'int', 'int', 'int', 'int[]'], expected: [new bn(1), 'gavofyork', new bn(2), new bn(3), new bn(4), 
                                                                                  [new bn(5), new bn(6), new bn(7)]],
                                                             values: '0000000000000000000000000000000000000000000000000000000000000001' +
                                                                      '00000000000000000000000000000000000000000000000000000000000000c0' +

test/coder.encodeParam.js

@@ -20,8 +20,19 @@ describe('lib/solidity/coder', function () {
         test({ type: 'int256', value: 1,            expected: '0000000000000000000000000000000000000000000000000000000000000001'});
         test({ type: 'int256', value: 16,           expected: '0000000000000000000000000000000000000000000000000000000000000010'});
         test({ type: 'int256', value: -1,           expected: 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff'});
-        test({ type: 'bytes32', value: 'gavofyork', expected: '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ type: 'bytes32', value: '0x6761766f66796f726b', 
-        test({ type: 'bytes', value: 'gavofyork',   expected: '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                    expected: '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ type: 'bytes32', value: '0x731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b', 
+                                                    expected: '731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b'});
+        test({ type: 'bytes', value: '0x6761766f66796f726b',   
+                                                    expected: '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                              '0000000000000000000000000000000000000000000000000000000000000009' +
+                                                              '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ type: 'bytes', value: '0x731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b',   
+                                                    expected: '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                              '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                              '731a3afc00d1b1e3461b955e53fc866dcf303b3eb9f4c16f89e388930f48134b'});
+        test({ type: 'string', value: 'gavofyork',  expected: '0000000000000000000000000000000000000000000000000000000000000020' +
                                                               '0000000000000000000000000000000000000000000000000000000000000009' +
                                                               '6761766f66796f726b0000000000000000000000000000000000000000000000'});
         test({ type: 'int[]', value: [],            expected: '0000000000000000000000000000000000000000000000000000000000000020' +
@@ -67,8 +78,9 @@ describe('lib/solidity/coder', function () {
         test({ types: ['int256'], values: [1],              expected: '0000000000000000000000000000000000000000000000000000000000000001'});
         test({ types: ['int256'], values: [16],             expected: '0000000000000000000000000000000000000000000000000000000000000010'});
         test({ types: ['int256'], values: [-1],             expected: 'ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff'});
-        test({ types: ['bytes32'], values: ['gavofyork'],   expected: '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ types: ['bytes32'], values: ['0x6761766f66796f726b'],   
-        test({ types: ['bytes'], values: ['gavofyork'],     expected: '0000000000000000000000000000000000000000000000000000000000000020' +
+                                                            expected: '6761766f66796f726b0000000000000000000000000000000000000000000000'});
+        test({ types: ['string'], values: ['gavofyork'],    expected: '0000000000000000000000000000000000000000000000000000000000000020' +
                                                                       '0000000000000000000000000000000000000000000000000000000000000009' +
                                                                       '6761766f66796f726b0000000000000000000000000000000000000000000000'});
         test({ types: ['int[]'], values: [[3]],             expected: '0000000000000000000000000000000000000000000000000000000000000020' +
@@ -91,18 +103,18 @@ describe('lib/solidity/coder', function () {
                                                                       '0000000000000000000000000000000000000000000000000000000000000002' +
                                                                       '0000000000000000000000000000000000000000000000000000000000000003' +
                                                                       '0000000000000000000000000000000000000000000000000000000000000004'});
-        test({ types: ['bytes32', 'int'], values: ['gavofyork', 5],
+        test({ types: ['bytes32', 'int'], values: ['0x6761766f66796f726b', 5],
                                                             expected: '6761766f66796f726b0000000000000000000000000000000000000000000000' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000005'});
-        test({ types: ['int', 'bytes32'], values: [5, 'gavofyork'],
+        test({ types: ['int', 'bytes32'], values: [5, '0x6761766f66796f726b'],
                                                             expected: '0000000000000000000000000000000000000000000000000000000000000005' + 
                                                                       '6761766f66796f726b0000000000000000000000000000000000000000000000'});
-        test({ types: ['bytes', 'int'], values: ['gavofyork', 5],
+        test({ types: ['string', 'int'], values: ['gavofyork', 5],
                                                             expected: '0000000000000000000000000000000000000000000000000000000000000040' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000005' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000009' + 
                                                                       '6761766f66796f726b0000000000000000000000000000000000000000000000'});
-        test({ types: ['bytes', 'bool', 'int[]'], values: ['gavofyork', true, [1, 2, 3]],
+        test({ types: ['string', 'bool', 'int[]'], values: ['gavofyork', true, [1, 2, 3]],
                                                             expected: '0000000000000000000000000000000000000000000000000000000000000060' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000001' + 
                                                                       '00000000000000000000000000000000000000000000000000000000000000a0' + 
@@ -112,7 +124,7 @@ describe('lib/solidity/coder', function () {
                                                                       '0000000000000000000000000000000000000000000000000000000000000001' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000002' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000003'});
-        test({ types: ['bytes', 'int[]'], values: ['gavofyork', [1, 2, 3]],
+        test({ types: ['string', 'int[]'], values: ['gavofyork', [1, 2, 3]],
                                                             expected: '0000000000000000000000000000000000000000000000000000000000000040' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000080' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000009' + 
@@ -121,12 +133,12 @@ describe('lib/solidity/coder', function () {
                                                                       '0000000000000000000000000000000000000000000000000000000000000001' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000002' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000003'});
-        test({ types: ['int', 'bytes'], values: [5, 'gavofyork'],
+        test({ types: ['int', 'string'], values: [5, 'gavofyork'],
                                                             expected: '0000000000000000000000000000000000000000000000000000000000000005' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000040' + 
                                                                       '0000000000000000000000000000000000000000000000000000000000000009' + 
                                                                       '6761766f66796f726b0000000000000000000000000000000000000000000000'});
-        test({ types: ['int', 'bytes', 'int', 'int', 'int', 'int[]'], values: [1, 'gavofyork', 2, 3, 4, [5, 6, 7]],
+        test({ types: ['int', 'string', 'int', 'int', 'int', 'int[]'], values: [1, 'gavofyork', 2, 3, 4, [5, 6, 7]],
                                                             expected: '0000000000000000000000000000000000000000000000000000000000000001' +
                                                                       '00000000000000000000000000000000000000000000000000000000000000c0' +
                                                                       '0000000000000000000000000000000000000000000000000000000000000002' +