embark/lib/modules/fuzzer/index.js

const utils = require('web3-utils');
const _ = require('underscore');


// generates random inputs based on the inputs of an ABI
class ContractFuzzer {
  constructor(embark) {
    //this.abi = abi;
    this.embark = embark;
    this.logger = embark.logger;
    this.events = embark.events;

    this.registerConsoleCommand();
  }

  // main function to call, takes in iteration number and a contract and returns a map object
  // composed of method names -> fuzzed inputs. 
  generateFuzz(iterations, contract) {
    let fuzzMap = {};
    for (let i = 0; i < iterations; i++) contract.abiDefinition.filter((x) => x.inputs && x.inputs.length != 0).forEach((abiMethod) => {
          let name = abiMethod.type === "constructor" ? "constructor" : abiMethod.name;
          console.log("name");
          let inputTypes = abiMethod.inputs.map(input => input.type);
          console.log("INPUT TYPES:", inputTypes);
          let fuzzedInputs = _.map(inputTypes, this.getTypeFuzz.bind(this));
          console.log("FUZZED INPUTS:", fuzzedInputs);
          fuzzMap[name] = fuzzedInputs;
          console.log("FUZZ KEYS SO FAR:", Object.keys(fuzzMap));
          console.log("FUZZ VALS SO FAR:", Object.values(fuzzMap));
        });
    console.log("FUZZ:", Object.keys(fuzzMap), Object.values(fuzzMap));
    return fuzzMap;
  }

  getTypeFuzz(typeString) {
    const self = this;
    console.log("TYPESTRING:", typeString);
    // Group 0: uint256[3]
    // Group 1: uint256
    // Group 2: uint
    // Group 3: 256
    // Group 4: [3]
    // Group 5: 3
    let regexObj = typeString.match(/((bool|int|uint|bytes|string|address)([0-9]*)?)(\[([0-9]*)\])*$/);
    console.log("REGEX OBJ:", regexObj);
    let type = regexObj[1];
    console.log("type:", type);
    let kind = regexObj[2];
    console.log("kind:", kind);
    let size = regexObj[3];
    console.log("size:", size);
    let array = regexObj[4];
    console.log("array:", array);
    let arraySize = regexObj[5];
    console.log("array size:", arraySize);
    switch(true) {
      case array !== undefined: {
        // if it's a dynamic array pick a number between 1 and 256 for length of array
        let length = arraySize === undefined || arraySize === null || arraySize === '' ? Math.floor((Math.random() * 256) + 1)  : arraySize;
        console.log("LENGTH: ", length);
        return self.generateArrayOfType(length, type);
      }
      case kind == "bool":
        return self.generateRandomBool();
      case kind == "uint" || kind == "int":
        return self.generateRandomInt(size);
      case kind === "bytes" && size !== undefined:
        return self.generateRandomStaticBytes(size);
      case kind === "string" || kind === "bytes":
        return self.generateRandomDynamicType();
      case kind === "address":
        return self.generateRandomAddress();
      default:
        throw new Error("Couldn't find proper ethereum abi type");
    }
  }

  generateRandomBool() {
    return _.sample([true, false]);
  }

  generateArrayOfType(length, type) {
    var arr = [];
    for (var i = 0; i < length; i++) {
      arr.push(this.getTypeFuzz(type));
    }
    console.log("Final Array:", arr);
    return arr;
  }

  generateRandomDynamicType() {
    return Math.random().toString(36).slice(2);
  }

  generateRandomStaticBytes(size) {
    return utils.randomHex(size);
  }

  generateRandomInt(size) {
    return utils.toBN(utils.randomHex(size / 8));
  }

  generateRandomAddress() {
    return utils.randomHex(20);
  }

  registerConsoleCommand() {
    const self = this;
    self.embark.registerConsoleCommand((cmd, _options) => {
      let splitCmd = cmd.split(' ');
      let cmdName = splitCmd[0];
      let contractName = splitCmd[1];
      let iterations = splitCmd[2] === undefined ? 1 : splitCmd[2];
      if (cmdName === 'fuzz') {
        self.events.request('contracts:contract', contractName, (contract) => {
          self.logger.info("--  fuzzed vals for " + contractName);
             this.generateFuzz(iterations, contract);
        });
        return "";
        }
        return false;
    });
  }
}

module.exports = ContractFuzzer;