Merge pull request #97 from 67P/chore/linter

Add linter and travis.yml

.eslintrc.js

@@ -0,0 +1,32 @@
+module.exports = {
+  'env': {
+    'browser': true,
+    'es6': true,
+    'node': true
+  },
+  'extends': 'eslint:recommended',
+  'globals': {
+    'Atomics': 'readonly',
+    'SharedArrayBuffer': 'readonly'
+  },
+  'parserOptions': {
+    'ecmaVersion': 2018,
+    'sourceType': 'module'
+  },
+  'rules': {
+    'comma-dangle': ['error', {
+      arrays: 'always-multiline',
+      objects: 'always-multiline',
+      imports: 'never',
+      exports: 'never',
+      functions: 'ignore',
+    }],
+    'eol-last': ['error', 'always'],
+    semi: ['error', 'always'],
+    'space-before-function-paren': ['error', {
+      anonymous: 'never',
+      named: 'always',
+      asyncArrow: 'always',
+    }],
+  }
+}

.solhint.json

@@ -0,0 +1,9 @@
+{
+  "extends": [
+    "solhint:default",
+    "solhint:recommended"
+  ],
+  "rules": {
+    "indent": "2"
+  }
+}

.travis.yml

@@ -0,0 +1,26 @@
+---
+language: node_js
+node_js:
+  - "11"
+
+sudo: false
+dist: xenial
+
+cache:
+  yarn: true
+
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash
+  - export PATH=$HOME/.yarn/bin:$PATH
+
+install:
+  - yarn install --no-lockfile --non-interactive
+
+script:
+  - yarn lint:wrapper
+  - yarn lint:contract-tests
+  # - yarn lint:contracts
+
+branches:
+  only:
+    - master

apps/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  'globals': {
+    contract: true,
+    describe: true,
+    it: true,
+  },
+  rules: {
+    'no-unused-vars': ['error', {
+      'argsIgnorePattern': '^_',
+    }],
+  }
+}

apps/contribution/test/app.js

@@ -1,5 +1,5 @@
-const Contribution = artifacts.require('Contribution.sol')
+// const Contribution = artifacts.require('Contribution.sol');
 
-contract('Contribution', (accounts) => {
-  it('should be tested')
-})
+contract('Contribution', (_accounts) => {
+  it('should be tested');
+});

apps/contributor/test/app.js

@@ -1,5 +1,5 @@
-const Contributor = artifacts.require('Contributor.sol')
+// const Contributor = artifacts.require('Contributor.sol');
 
-contract('Contributor', (accounts) => {
-  it('should be tested')
-})
+contract('Contributor', (_accounts) => {
+  it('should be tested');
+});

apps/proposal/test/app.js

@@ -1,5 +1,5 @@
-const Proposal = artifacts.require('Proposal.sol')
+// const Proposal = artifacts.require('Proposal.sol');
 
-contract('Proposal', (accounts) => {
-  it('should be tested')
-})
+contract('Proposal', (_accounts) => {
+  it('should be tested');
+});

apps/token/test/app.js

@@ -1,5 +1,5 @@
-const Token = artifacts.require('Token.sol')
+// const Token = artifacts.require('Token.sol');
 
-contract('Token', (accounts) => {
-  it('should be tested')
-})
+contract('Token', (_accounts) => {
+  it('should be tested');
+});

lib/contracts/acl.js

@@ -2,11 +2,15 @@ const Base = require('./base');
 const EthersUtils = require('ethers').utils;
 
 class Acl extends Base {
-
-  hasPermission(fromAddress, contractAddress, roleID, params = null) {
+  hasPermission (fromAddress, contractAddress, roleID, params = null) {
     let roleHash = EthersUtils.keccak256(EthersUtils.toUtf8Bytes(roleID));
-    console.log(roleHash)
-    return this.functions.hasPermission(fromAddress, contractAddress, roleHash, params);
+
+    return this.functions.hasPermission(
+      fromAddress,
+      contractAddress,
+      roleHash,
+      params
+    );
   }
 }
 

lib/contracts/base.js

@@ -1,22 +1,22 @@
 class Base {
-  constructor(contract) {
+  constructor (contract) {
     this.contract = contract;
   }
 
-  get functions() {
+  get functions () {
     return this.contract.functions;
   }
 
-  get ipfs() {
+  get ipfs () {
     if (!this._ipfsAPI) { throw new Error('IPFS API not configured; please set an ipfs instance'); }
     return this._ipfsAPI;
   }
 
-  set ipfs(ipfsAPI) {
+  set ipfs (ipfsAPI) {
     this._ipfsAPI = ipfsAPI;
   }
 
-  on(type, callback) {
+  on (type, callback) {
     return this.contract.on(type, callback);
   }
 }

lib/contracts/contribution.js

@@ -6,20 +6,19 @@ class Contribution extends Record {
     return this.functions.contributionsCount();
   }
 
-  getById(id) {
+  getById (id) {
     return this.functions.getContribution(id)
       .then(data => {
         return this.ipfs.catAndMerge(data, ContributionSerializer.deserialize);
       });
-
   }
 
-  getByContributorId(contributorId) {
+  getByContributorId (contributorId) {
     return this.functions.getContributorAddressById(contributorId)
       .then(address => this.getByContributorAddress(address));
   }
 
-  getByContributorAddress(address) {
+  getByContributorAddress (address) {
     return this.functions.balanceOf(address)
       .then(async (balance) => {
         const count = balance.toNumber();
@@ -35,7 +34,7 @@ class Contribution extends Record {
       });
   }
 
-  async addContribution(contributionAttr, callOptions = {}) {
+  async addContribution (contributionAttr, callOptions = {}) {
     const contribution = new ContributionSerializer(contributionAttr);
 
     try { await contribution.validate(); }

lib/contracts/contributor.js

@@ -7,23 +7,23 @@ class Contributor extends Record {
     return this.functions.contributorsCount();
   }
 
-  getById(id) {
+  getById (id) {
     return this.functions.getContributorById(id)
       .then(data => {
         data.balanceInt = formatKredits(data.balance);
         return this.ipfs.catAndMerge(data, ContributorSerializer.deserialize);
-      })
+      });
   }
 
-  filterByAccount(search) {
+  filterByAccount (search) {
     return this._byAccount(search, 'filter');
   }
 
-  findByAccount(search) {
+  findByAccount (search) {
     return this._byAccount(search, 'find');
   }
 
-  _byAccount(search, method = 'filter') {
+  _byAccount (search, method = 'filter') {
     return this.all().then((contributors) => {
       const searchEntries = Object.entries(search);
 
@@ -39,7 +39,7 @@ class Contributor extends Record {
     });
   }
 
-  async add(contributorAttr, callOptions = {}) {
+  async add (contributorAttr, callOptions = {}) {
     let contributor = new ContributorSerializer(contributorAttr);
 
     try { await contributor.validate(); }
@@ -61,9 +61,9 @@ class Contributor extends Record {
       });
   }
 
-  updateProfile(contributorId, updateAttr, callOptions = {}) {
+  updateProfile (contributorId, updateAttr, callOptions = {}) {
     return this.getById(contributorId).then(async (contributor) => {
-      let updatedContributorAttr = Object.assign(contributor, updateAttr)
+      let updatedContributorAttr = Object.assign(contributor, updateAttr);
       let updatedContributor = new ContributorSerializer(updatedContributorAttr);
 
       try { await updatedContributor.validate(); }

lib/contracts/index.js

@@ -4,5 +4,5 @@ module.exports = {
   Proposal: require('./proposal'),
   Token: require('./token'),
   Kernel: require('./kernel'),
-  Acl: require('./acl')
+  Acl: require('./acl'),
 };

lib/contracts/kernel.js

@@ -4,19 +4,19 @@ const Base = require('./base');
 const KERNEL_APP_ADDR_NAMESPACE = '0xd6f028ca0e8edb4a8c9757ca4fdccab25fa1e0317da1188108f7d2dee14902fb';
 
 class Kernel extends Base {
-  constructor(contract) {
+  constructor (contract) {
     super(contract);
     this.apm = 'aragonpm.eth'; // can be overwritten if needed
   }
 
-  getApp(appName) {
+  getApp (appName) {
     if (appName === 'Acl') {
       return this.functions.acl();
     }
     return this.functions.getApp(KERNEL_APP_ADDR_NAMESPACE, this.appNamehash(appName));
   }
 
-  appNamehash(appName) {
+  appNamehash (appName) {
     return namehash(`kredits-${appName.toLowerCase()}.${this.apm}`);
   }
 }

lib/contracts/proposal.js

@@ -6,14 +6,14 @@ class Proposal extends Record {
     return this.functions.proposalsCount();
   }
 
-  getById(id) {
+  getById (id) {
     return this.functions.getProposal(id)
       .then(data => {
         return this.ipfs.catAndMerge(data, ContributionSerializer.deserialize);
       });
   }
 
-  async addProposal(proposalAttr, callOptions = {}) {
+  async addProposal (proposalAttr, callOptions = {}) {
     const contribution = new ContributionSerializer(proposalAttr);
 
     try { await contribution.validate(); }
@@ -37,4 +37,4 @@ class Proposal extends Record {
   }
 }
 
-module.exports = Proposal
+module.exports = Proposal;

lib/contracts/record.js

@@ -2,7 +2,7 @@ const Base = require('./base');
 const paged = require('../utils/pagination');
 
 class Record extends Base {
-  all(options = {}) {
+  all (options = {}) {
     return this.count
       .then((count) => {
         let records = paged(count, options).map((id) => this.getById(id));
@@ -11,4 +11,4 @@ class Record extends Base {
   }
 }
 
-module.exports = Record
+module.exports = Record;

lib/kredits.js

@@ -1,6 +1,7 @@
 const ethers = require('ethers');
 
 const Preflight = require('./utils/preflight');
+const deprecate = require('./utils/deprecate');
 
 const ABIS = {
   Contributor: require('./abis/Contributor.json'),
@@ -8,29 +9,29 @@ const ABIS = {
   Token: require('./abis/Token.json'),
   Proposal: require('./abis/Proposal.json'),
   Kernel: require('./abis/Kernel.json'),
-  Acl: require('./abis/ACL.json')
+  Acl: require('./abis/ACL.json'),
 };
 const APP_CONTRACTS = [
   'Contributor',
   'Contribution',
   'Token',
   'Proposal',
-  'Acl'
+  'Acl',
 ];
 const DaoAddresses = require('./addresses/dao.json');
 
 const Contracts = require('./contracts');
-const IPFS = require('./utils/ipfs')
+const IPFS = require('./utils/ipfs');
 
 // Helpers
-function capitalize(word) {
+function capitalize (word) {
   let [first, ...rest] = word;
   return `${first.toUpperCase()}${rest.join('')}`;
 }
 
 class Kredits {
 
-  constructor(provider, signer, options = {}) {
+  constructor (provider, signer, options = {}) {
     let { addresses, abis, ipfsConfig } = options;
 
     this.provider = provider;
@@ -42,7 +43,7 @@ class Kredits {
     this.contracts = {};
   }
 
-  init(names) {
+  init (names) {
     let contractsToLoad = names || APP_CONTRACTS;
     return this.provider.getNetwork().then(network => {
       this.addresses['Kernel'] = this.addresses['Kernel'] || DaoAddresses[network.chainId.toString()];
@@ -50,23 +51,22 @@ class Kredits {
         return this.Kernel.getApp(contractName).then((address) => {
           this.addresses[contractName] = address;
         }).catch((error) => {
-          console.log(error);
           throw new Error(`Failed to get address for ${contractName} from DAO at ${this.Kernel.contract.address}
             - ${error.message}`
           );
         });
       });
 
-      return Promise.all(addressPromises).then(() => { return this });
+      return Promise.all(addressPromises).then(() => { return this; });
     });
   }
 
-  static setup(provider, signer, ipfsConfig = null) {
-    console.log('Kredits.setup() is deprecated use new Kredits().init() instead');
+  static setup (provider, signer, ipfsConfig = null) {
+    deprecate('Kredits.setup() is deprecated use new Kredits().init() instead');
     return new Kredits(provider, signer, { ipfsConfig: ipfsConfig }).init();
   }
 
-  get Kernel() {
+  get Kernel () {
     let k = this.contractFor('Kernel');
     // in case we want to use a special apm (e.g. development vs. production)
     if (this.options.apm) {
@@ -75,37 +75,37 @@ class Kredits {
     return k;
   }
 
-  get Contributor() {
+  get Contributor () {
     return this.contractFor('Contributor');
   }
 
-  get Contributors() {
-    console.log('Contributors is deprecated use Contributor instead');
+  get Contributors () {
+    deprecate('Contributors is deprecated use Contributor instead');
     return this.Contributor;
   }
 
-  get Proposal() {
+  get Proposal () {
     return this.contractFor('Proposal');
   }
 
-  get Operator() {
+  get Operator () {
     return this.Proposal;
   }
 
-  get Token() {
+  get Token () {
     return this.contractFor('Token');
   }
 
-  get Contribution() {
+  get Contribution () {
     return this.contractFor('Contribution');
   }
 
-  get Acl() {
+  get Acl () {
     return this.contractFor('Acl');
   }
 
   // Should be private
-  contractFor(name) {
+  contractFor (name) {
     if (this.contracts[name]) {
       return this.contracts[name];
     }
@@ -125,7 +125,7 @@ class Kredits {
     return this.contracts[name];
   }
 
-  preflightChecks() {
+  preflightChecks () {
     return new Preflight(this).check();
   }
 }

lib/serializers/contribution.js

@@ -9,7 +9,7 @@ const validator = require('../utils/validator');
  */
 class Contribution {
 
-  constructor(attrs) {
+  constructor (attrs) {
     Object.keys(attrs).forEach(a => this[a] = attrs[a]);
   }
 
@@ -26,24 +26,24 @@ class Contribution {
       kind,
       description,
       url,
-      details
+      details,
     } = this;
 
     let data = {
-      "@context": "https://schema.kosmos.org",
-      "@type": "Contribution",
-      "contributor": {
-        "ipfs": contributorIpfsHash
+      '@context': 'https://schema.kosmos.org',
+      '@type': 'Contribution',
+      'contributor': {
+        'ipfs': contributorIpfsHash,
       },
       date,
       time,
       kind,
       description,
-      "details": details || {}
+      'details': details || {},
     };
 
     if (url) {
-      data["url"] = url;
+      data['url'] = url;
     }
 
     // Write it pretty to ipfs

lib/serializers/contributor.js

@@ -9,7 +9,7 @@ const validator = require('../utils/validator');
  */
 class Contributor {
 
-  constructor(attrs) {
+  constructor (attrs) {
     Object.keys(attrs).forEach(a => this[a] = attrs[a]);
   }
 
@@ -31,39 +31,39 @@ class Contributor {
     } = this;
 
     let data = {
-      "@context": "https://schema.kosmos.org",
-      "@type": "Contributor",
+      '@context': 'https://schema.kosmos.org',
+      '@type': 'Contributor',
       kind,
       name,
-      "accounts": []
+      'accounts': [],
     };
 
     if (url) {
-      data["url"] = url;
+      data['url'] = url;
     }
 
     if (github_uid) {
       data.accounts.push({
-        "site": "github.com",
-        "uid": github_uid,
-        "username": github_username,
-        "url": `https://github.com/${github_username}`
+        'site': 'github.com',
+        'uid': github_uid,
+        'username': github_username,
+        'url': `https://github.com/${github_username}`,
       });
     }
 
     if (gitea_username) {
       data.accounts.push({
-        "site": "gitea.kosmos.org",
-        "username": gitea_username,
-        "url": `https://gitea.kosmos.org/${gitea_username}`
+        'site': 'gitea.kosmos.org',
+        'username': gitea_username,
+        'url': `https://gitea.kosmos.org/${gitea_username}`,
       });
     }
 
     if (wiki_username) {
       data.accounts.push({
-        "site": "wiki.kosmos.org",
-        "username": wiki_username,
-        "url": `https://wiki.kosmos.org/User:${wiki_username}`
+        'site': 'wiki.kosmos.org',
+        'username': wiki_username,
+        'url': `https://wiki.kosmos.org/User:${wiki_username}`,
       });
     }
 

lib/utils/deprecate.js

@@ -0,0 +1,5 @@
+/*eslint no-console: ["error", { allow: ["warn"] }] */
+
+module.exports = function deprecate (msg) {
+  console.warn(msg);
+};

lib/utils/format-kredits.js

@@ -1,10 +1,10 @@
 const ethersUtils = require('ethers').utils;
 
-module.exports = function (value, options = {}) {
+module.exports = function(value, options = {}) {
   let etherValue = ethersUtils.formatEther(value);
   if (options.asFloat) {
     return parseFloat(etherValue);
   } else {
     return parseInt(etherValue);
   }
-}
+};

lib/utils/ipfs.js

@@ -2,8 +2,7 @@ const ipfsClient = require('ipfs-http-client');
 const multihashes = require('multihashes');
 
 class IPFS {
-
-  constructor(config) {
+  constructor (config) {
     if (!config) {
       config = { host: 'localhost', port: '5001', protocol: 'http' };
     }
@@ -11,7 +10,7 @@ class IPFS {
     this._config = config;
   }
 
-  catAndMerge(data, deserialize) {
+  catAndMerge (data, deserialize) {
     // if no hash details are found simply return the data; nothing to merge
     if (!data.hashSize || data.hashSize === 0) {
       return data;
@@ -26,7 +25,7 @@ class IPFS {
       });
   }
 
-  add(data) {
+  add (data) {
     return this._ipfsAPI
       .add(ipfsClient.Buffer.from(data))
       .then((res) => {
@@ -34,7 +33,7 @@ class IPFS {
       });
   }
 
-  cat(hashData) {
+  cat (hashData) {
     let ipfsHash = hashData; // default - if it is a string
     if (hashData.hasOwnProperty('hashSize')) {
       ipfsHash = this.encodeHash(hashData);
@@ -42,21 +41,20 @@ class IPFS {
     return this._ipfsAPI.cat(ipfsHash);
   }
 
-  decodeHash(ipfsHash) {
+  decodeHash (ipfsHash) {
     let multihash = multihashes.decode(multihashes.fromB58String(ipfsHash));
     return {
       hashDigest: '0x' + multihashes.toHexString(multihash.digest),
       hashSize: multihash.length,
       hashFunction: multihash.code,
-      ipfsHash: ipfsHash
+      ipfsHash: ipfsHash,
     };
   }
 
-  encodeHash(hashData) {
+  encodeHash (hashData) {
     let digest = ipfsClient.Buffer.from(hashData.hashDigest.slice(2), 'hex');
     return multihashes.encode(digest, hashData.hashFunction, hashData.hashSize);
   }
-
 }
 
 module.exports = IPFS;

lib/utils/pagination.js

@@ -1,4 +1,4 @@
-function pageNumber(number, size, recordCount) {
+function pageNumber (number, size, recordCount) {
   let numberOfPages = Math.ceil(recordCount / size);
 
   number = parseInt(number) || 1;
@@ -10,7 +10,7 @@ function pageNumber(number, size, recordCount) {
   return number;
 }
 
-function buildIds(order, number, size, recordCount) {
+function buildIds (order, number, size, recordCount) {
   let offset = size * (number - 1);
 
   let start;
@@ -34,7 +34,7 @@ function buildIds(order, number, size, recordCount) {
   return Array.from({ length: size }, mapFunction);
 }
 
-module.exports = function paged(recordCount, options = {}) {
+module.exports = function paged (recordCount, options = {}) {
   let { order, page } = options;
   order = order || 'desc';
   page = page || {};

lib/utils/preflight.js

@@ -1,9 +1,9 @@
 class Preflight {
-  constructor(kredits) {
+  constructor (kredits) {
     this.kredits = kredits;
   }
 
-  check() {
+  check () {
     return this.kredits.ipfs._ipfsAPI.id()
       .catch((error) => {
         throw new Error(`IPFS node not available; config: ${JSON.stringify(this.kredits.ipfs.config)} - ${error.message}`);

lib/utils/validator.js

@@ -4,12 +4,12 @@ const validator = tv4.freshApi();
 validator.addFormat({
   'date': function(value) {
     const dateRegexp = /^[0-9]{4,}-[0-9]{2}-[0-9]{2}$/;
-    return dateRegexp.test(value) ? null : "A valid ISO 8601 full-date string is expected";
+    return dateRegexp.test(value) ? null : 'A valid ISO 8601 full-date string is expected';
   },
   'time': function(value) {
-    const timeRegexp = /^([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]+)?(([Zz])|([\+|\-]([01][0-9]|2[0-3]):[0-5][0-9]))$/;
-    return timeRegexp.test(value) ? null : "A valid ISO 8601 full-time string is expected";
-  }
-})
+    const timeRegexp = /^([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\.[0-9]+)?(([Zz])|([+|-]([01][0-9]|2[0-3]):[0-5][0-9]))$/;
+    return timeRegexp.test(value) ? null : 'A valid ISO 8601 full-time string is expected';
+  },
+});
 
 module.exports = validator;

package.json

@@ -20,6 +20,9 @@
     "deploy:apps": "./scripts/every-app.sh \"aragon apm publish major\"",
     "devchain": "aragon devchain --port 7545",
     "dao:address": "truffle exec scripts/current-address.js",
+    "lint:contracts": "solhint \"contracts/**/*.sol\" \"apps/*/contracts/**/*.sol\"",
+    "lint:contract-tests": "eslint apps/*/test",
+    "lint:wrapper": "eslint lib/",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -37,10 +40,15 @@
     "@aragon/kits-base": "^1.0.0",
     "@aragon/os": "^4.1.0",
     "async-each-series": "^1.1.0",
+    "eslint": "^5.16.0",
+    "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-node": "^8.0.1",
+    "eslint-plugin-promise": "^4.1.1",
     "eth-provider": "^0.2.2",
     "openzeppelin-solidity": "^2.2.0",
     "promptly": "^3.0.3",
-    "solc": "^0.4.25"
+    "solc": "^0.4.25",
+    "solhint": "^2.0.0"
   },
   "dependencies": {
     "ethers": "^4.0.27",