Add tuple support in interactive prompts

packages/cli/contracts/mocks/ImplV1.sol

@@ -1,4 +1,5 @@
 pragma solidity ^0.5.0;
+pragma experimental ABIEncoderV2;
 
 import "./Libraries.sol";
 import "mock-stdlib/contracts/GreeterImpl.sol";
@@ -9,6 +10,8 @@ contract ImplV1 {
 
   event InitializeEvent(uint256 value);
 
+  struct MyTuple { uint256 value; string text; }
+
   function initialize(uint256 _value) public {
     value = _value;
   }
@@ -39,6 +42,10 @@ contract ImplV1 {
     return numbers;
   }
 
+  function echoTuple(MyTuple memory t) public pure returns (MyTuple memory) {
+    return t;
+  }
+
   function doesNotReturn() public pure {
     uint256 num = 42;
     num = num + 41;

packages/cli/contracts/mocks/ImplV2.sol

@@ -1,4 +1,5 @@
 pragma solidity ^0.5.0;
+pragma experimental ABIEncoderV2;
 
 import "./ImplV1.sol";
 

packages/cli/package.json

@@ -8,7 +8,7 @@
   "scripts": {
     "copy-files": "./scripts/copy-files.sh",
     "compile-ts": "rm -rf lib && tsc",
-    "compile-contracts": "rm -rf build/contracts && ../../bootstrap/node_modules/.bin/oz compile --solc-version 0.5.3 --evm-version constantinople",
+    "compile-contracts": "rm -rf build/contracts && ../../bootstrap/node_modules/.bin/oz compile --solc-version 0.5.14 --evm-version constantinople",
     "prepare": "npm run compile-contracts && npm run compile-ts && npm run copy-files && chmod 755 ./lib/bin/oz-cli.js",
     "test": "TS_NODE_PROJECT='tsconfig.test.json' mocha --require ts-node/register --recursive test",
     "gen-docs": "./scripts/gen-docs.sh",
@@ -116,6 +116,7 @@
     "lodash.uniq": "^4.5.0",
     "lodash.uniqby": "^4.7.0",
     "lodash.uniqwith": "^4.5.0",
+    "lodash.zipwith": "^4.2.0",
     "npm-programmatic": "0.0.12",
     "rlp": "^2.2.3",
     "semver": "^5.5.0",

packages/cli/src/models/network/TransactionController.ts

@@ -11,7 +11,7 @@ import ProjectFile from '../files/ProjectFile';
 import NetworkFile from '../files/NetworkFile';
 import { describeEvents } from '../../utils/events';
 
-const { buildCallData, callDescription } = ABI;
+const { getABIFunction, callDescription } = ABI;
 
 interface ERC20TokenInfo {
   balance?: string;
@@ -137,7 +137,7 @@ export default class TransactionController {
     const { package: packageName, contract: contractName } = this.networkFile.getProxy(address);
     const contractManager = new ContractManager(this.projectFile);
     const contract = contractManager.getContractClass(packageName, contractName).at(address);
-    const { method } = buildCallData(contract, methodName, methodArgs);
+    const method = getABIFunction(contract, methodName, methodArgs);
 
     return { contract, method };
   }

packages/cli/src/prompts/method-params.ts

@@ -3,8 +3,8 @@ import pickBy from 'lodash.pickby';
 import isUndefined from 'lodash.isundefined';
 import negate from 'lodash.negate';
 
-import { parseMethodParams, parseArg } from '../utils/input';
-import { promptIfNeeded, argsList, methodsList, InquirerQuestions } from './prompt';
+import { parseMethodParams, parseArg, getSampleInput } from '../utils/input';
+import { promptIfNeeded, argsList, methodsList, InquirerQuestions, argLabel } from './prompt';
 
 type PropsFn = (any) => InquirerQuestions;
 
@@ -59,18 +59,20 @@ function getCommandProps(
     return {
       ...accum,
       [arg.name]: {
-        message: arg.name ? `${arg.name} (${arg.type}):` : `(${arg.type}):`,
+        message: `${argLabel(arg)}:`,
         type: 'input',
         when: () => !methodArgs || !methodArgs[index],
-        validate: input => {
+        validate: (input: string) => {
           try {
-            parseArg(input, arg.type);
+            parseArg(input, arg);
             return true;
           } catch (err) {
-            return `${err.message}. Enter a valid ${arg.type} such as: ${getPlaceholder(arg.type)}.`;
+            const placeholder = getSampleInput(arg);
+            const msg = placeholder ? `Enter a valid ${arg.type} such as: ${placeholder}` : `Enter a valid ${arg.type}`;
+            return `${err.message}. ${msg}.`;
           }
         },
-        normalize: input => parseArg(input, arg.type),
+        normalize: input => parseArg(input, arg),
       },
     };
   }, {});
@@ -98,30 +100,3 @@ function getCommandProps(
     ...args,
   };
 }
-
-function getPlaceholder(type: string): string {
-  const ARRAY_TYPE_REGEX = /(.+)\[\d*\]$/; // matches array type identifiers like uint[] or byte[4]
-
-  if (type.match(ARRAY_TYPE_REGEX)) {
-    const arrayType = type.match(ARRAY_TYPE_REGEX)[1];
-    const itemPlaceholder = getPlaceholder(arrayType);
-    return `[${itemPlaceholder}, ${itemPlaceholder}]`;
-  } else if (
-    type.startsWith('uint') ||
-    type.startsWith('int') ||
-    type.startsWith('fixed') ||
-    type.startsWith('ufixed')
-  ) {
-    return '42';
-  } else if (type === 'bool') {
-    return 'true';
-  } else if (type === 'bytes') {
-    return '0xabcdef';
-  } else if (type === 'address') {
-    return '0x1df62f291b2e969fb0849d99d9ce41e2f137006e';
-  } else if (type === 'string') {
-    return 'Hello world';
-  } else {
-    return null;
-  }
-}

packages/cli/src/prompts/prompt.ts

@@ -4,7 +4,7 @@ import isEmpty from 'lodash.isempty';
 import groupBy from 'lodash.groupby';
 import difference from 'lodash.difference';
 import inquirer from 'inquirer';
-import { contractMethodsFromAbi, ContractMethodMutability as Mutability } from '@openzeppelin/upgrades';
+import { contractMethodsFromAbi, ContractMethodMutability as Mutability, ABI } from '@openzeppelin/upgrades';
 
 import Session from '../models/network/Session';
 import ConfigManager from '../models/config/ConfigManager';
@@ -52,6 +52,16 @@ interface MethodOptions {
   constant?: boolean;
 }
 
+export interface MethodArgType {
+  type: string;
+  internalType?: string;
+  components?: MethodArg[];
+}
+
+export interface MethodArg extends MethodArgType {
+  name: string;
+}
+
 export const DISABLE_INTERACTIVITY: boolean =
   !process.stdin.isTTY ||
   !!process.env.OPENZEPPELIN_NON_INTERACTIVE ||
@@ -176,7 +186,7 @@ export function methodsList(
   return contractMethods(contractFullName, constant, projectFile)
     .map(({ name, hasInitializer, inputs, selector }) => {
       const initializable = hasInitializer ? '* ' : '';
-      const args = inputs.map(({ name: inputName, type }) => (inputName ? `${inputName}: ${type}` : type));
+      const args = inputs.map(argLabel);
       const label = `${initializable}${name}(${args.join(', ')})`;
 
       return { name: label, value: { name, selector } };
@@ -192,13 +202,17 @@ export function methodsList(
     });
 }
 
+export function argLabel(arg: MethodArg): string {
+  return arg.name ? `${arg.name}: ${ABI.getArgTypeLabel(arg)}` : ABI.getArgTypeLabel(arg);
+}
+
 // Returns an inquirer question with a list of arguments for a particular method
 export function argsList(
   contractFullName: string,
   methodIdentifier: string,
   constant?: Mutability,
   projectFile?: ProjectFile,
-): { name: string; type: string }[] {
+): MethodArg[] {
   const method = contractMethods(contractFullName, constant, projectFile).find(
     ({ name, selector }): any => selector === methodIdentifier || name === methodIdentifier,
   );

packages/cli/src/utils/input.ts

@@ -1,6 +1,8 @@
 import BN from 'bignumber.js';
 import flattenDeep from 'lodash.flattendeep';
 import { encodeParams, Loggy, ZWeb3 } from '@openzeppelin/upgrades';
+import { MethodArgType } from '../prompts/prompt';
+import zipWith from 'lodash.zipwith';
 
 // TODO: Deprecate in favor of a combination of parseArg and parseArray
 export function parseArgs(args: string): string[] | never {
@@ -46,18 +48,24 @@ function quoteArguments(args: string) {
   return args;
 }
 
-export function parseArg(input: string | string[], type: string): any {
+export function parseArg(input: string | string[], { type, components }: MethodArgType): any {
   const TRUE_VALUES = ['y', 'yes', 't', 'true', '1'];
   const FALSE_VALUES = ['n', 'no', 'f', 'false', '0'];
   const ARRAY_TYPE_REGEX = /(.+)\[\d*\]$/; // matches array type identifiers like uint[] or byte[4]
 
-  // TODO: Handle tuples in ABI specification
+  // Tuples: recursively parse
+  if (type === 'tuple') {
+    const inputs = typeof input === 'string' ? parseArray(stripParens(input), '(', ')') : input;
+    if (inputs.length !== components.length)
+      throw new Error(`Expected ${components.length} values but got ${input.length}`);
+    return zipWith(inputs, components, parseArg);
+  }
 
   // Arrays: recursively parse
-  if (type.match(ARRAY_TYPE_REGEX)) {
+  else if (type.match(ARRAY_TYPE_REGEX)) {
     const arrayType = type.match(ARRAY_TYPE_REGEX)[1];
     const inputs = typeof input === 'string' ? parseArray(stripBrackets(input)) : input;
-    return inputs.map(input => parseArg(input, arrayType));
+    return inputs.map(input => parseArg(input, { type: arrayType }));
   }
 
   // Integers: passed via bignumber to handle signs and scientific notation
@@ -110,6 +118,10 @@ export function stripBrackets(inputMaybeWithBrackets: string): string {
   return `${inputMaybeWithBrackets.replace(/^\s*\[/, '').replace(/\]\s*$/, '')}`;
 }
 
+export function stripParens(inputMaybeWithParens: string): string {
+  return `${inputMaybeWithParens.replace(/^\s*\(/, '').replace(/\)\s*$/, '')}`;
+}
+
 function requireInputString(arg: string | string[]): arg is string {
   if (typeof arg !== 'string') {
     throw new Error(`Expected ${flattenDeep(arg).join(',')} to be a scalar value but was an array`);
@@ -126,7 +138,7 @@ function requireInputString(arg: string | string[]): arg is string {
  * with arbitrarily nested string arrays, but ts has a hard time handling that,
  * so we're fooling it into thinking it's just one level deep.
  */
-export function parseArray(input: string): (string | string[])[] {
+export function parseArray(input: string, open = '[', close = ']'): (string | string[])[] {
   let i = 0; // index for traversing input
 
   function innerParseQuotedString(quoteChar: string): string {
@@ -148,9 +160,9 @@ export function parseArray(input: string): (string | string[])[] {
         return input.slice(start, i - 1);
       } else if (char === '"' || char === "'") {
         throw new Error(`Unexpected quote at position ${i}`);
-      } else if (char === '[' || char === "'") {
+      } else if (char === open || char === "'") {
         throw new Error(`Unexpected opening bracket at position ${i}`);
-      } else if (char === ']') {
+      } else if (char === close) {
         return input.slice(start, --i);
       }
     }
@@ -164,7 +176,7 @@ export function parseArray(input: string): (string | string[])[] {
         continue;
       } else if (char === ',') {
         return;
-      } else if (char === ']') {
+      } else if (char === close) {
         i--;
         return;
       } else {
@@ -183,11 +195,11 @@ export function parseArray(input: string): (string | string[])[] {
       } else if (char === '"' || char === "'") {
         result.push(innerParseQuotedString(char));
         requireCommaOrClosing();
-      } else if (char === '[') {
+      } else if (char === open) {
         const innerArray = innerParseArray();
         result.push(innerArray);
         requireCommaOrClosing();
-      } else if (char === ']') {
+      } else if (char === close) {
         if (!requireClosingBracket) throw new Error(`Unexpected closing array at position ${i + 1} in ${input}`);
         return result;
       } else {
@@ -238,3 +250,35 @@ export function validateSalt(salt: string, required = false) {
     throw new Error(`Invalid salt ${salt}, must be an uint256 value.`);
   }
 }
+
+export function getSampleInput(arg: MethodArgType): string | null {
+  const ARRAY_TYPE_REGEX = /(.+)\[\d*\]$/; // matches array type identifiers like uint[] or byte[4]
+  const { type, components } = arg;
+
+  if (type.match(ARRAY_TYPE_REGEX)) {
+    const arrayType = type.match(ARRAY_TYPE_REGEX)[1];
+    const itemPlaceholder = getSampleInput({ type: arrayType });
+    return `[${itemPlaceholder}, ${itemPlaceholder}]`;
+  } else if (
+    type.startsWith('uint') ||
+    type.startsWith('int') ||
+    type.startsWith('fixed') ||
+    type.startsWith('ufixed')
+  ) {
+    return '42';
+  } else if (type === 'bool') {
+    return 'true';
+  } else if (type === 'bytes') {
+    return '0xabcdef';
+  } else if (type === 'address') {
+    return '0x1df62f291b2e969fb0849d99d9ce41e2f137006e';
+  } else if (type === 'string') {
+    return 'Hello world';
+  } else if (type === 'tuple' && components) {
+    return `(${components.map(c => getSampleInput(c)).join(', ')})`;
+  } else if (type === 'tuple') {
+    return `(Hello world, 42)`;
+  } else {
+    return null;
+  }
+}

packages/cli/test/prompts/prompt.test.js

@@ -257,15 +257,15 @@ describe('prompt', function() {
           it('returns an array of method arguments names', function() {
             const args = argsList('Greeter', 'greet(string)', Mutability.NotConstant, this.projectFile);
             args.should.be.an('array');
-            args[0].should.deep.equal({ name: 'who', type: 'string' });
+            args[0].should.deep.include({ name: 'who', type: 'string' });
           });
         });
 
         context('when the argument has no name', function() {
           it('returns an array of method arguments names', function() {
             const args = argsList('Greeter', 'greetings(uint256)', Mutability.Constant, this.projectFile);
             args.should.be.an('array');
-            args[0].should.deep.equal({ name: '#0', type: 'uint256' });
+            args[0].should.deep.include({ name: '#0', type: 'uint256' });
           });
         });
       });

packages/cli/test/scripts/call.test.js

@@ -220,6 +220,26 @@ describe('call script', function() {
           this.logs.infos[this.logs.infos.length - 1].should.eq(`Method 'sayNumbers' returned: [1,2,3]`);
         });
       });
+
+      context('when the method takes and returns a struct', function() {
+        it('calls the method and logs the struct', async function() {
+          const proxyAddress = this.networkFile.getProxies({
+            contract: 'Impl',
+          })[0].address;
+          await call({
+            network,
+            txParams,
+            networkFile: this.networkFile,
+            proxyAddress,
+            methodName: 'echoTuple((uint256,string))',
+            methodArgs: [['42', 'Hello']],
+          });
+
+          this.logs.infos[this.logs.infos.length - 1].should.eq(
+            `Method 'echoTuple((uint256,string))' returned: [42,Hello]`,
+          );
+        });
+      });
     });
   });
 });