3.4.1

Fix warnings from express session

README.md

@@ -0,0 +1,118 @@
+[![npm](https://img.shields.io/npm/v/hubot-kredits.svg)](https://www.npmjs.com/package/hubot-kredits)
+
+# Hubot Kredits
+
+This repository provides scripts for integrating [Kosmos
+Kredits](https://wiki.kosmos.org/Kredits) in [Hubot](http://hubot.github.com/)
+chatbots. The bot will watch for project-related things happening on the
+Internet and automatically create ERC721 tokens for issuing kredits for project
+contributions.
+
+## Setup
+
+### Ethereum wallet
+
+You will need an Ethereum wallet for your bot, so it can interact with the
+Ethereum smart contracts. `npm run create-wallet` will do the job for you.
+
+The wallet must be funded with enough ETH to interact with the contracts.
+
+### Contract permissions
+
+The bot wallet needs the following Aragon contract permissions to interact
+with [kredits-contracts]:
+
+1. `ADD_CONTRIBUTION_ROLE` on the `Contribution` contract
+2. `MANAGE_CONTRIBUTORS_ROLE` on the `Contributor` contract
+
+These permissions can be configured using the [Aragon
+CLI](https://hack.aragon.org/docs/cli-intro.html) (see [kredits-contracts].
+
+    aragon dao acl grant [DAO address] [contribution app address] ADD_CONTRIBUTION_ROLE [bot wallet address]
+    aragon dao acl grant [DAO address] [contributor app address] MANAGE_CONTRIBUTORS_ROLE [bot wallet address]
+
+To get the `Contribution` and `Contributor` app addresses use `aragon dao apps`.
+
+## Configuration
+
+As usual in Hubot, you can add all config as environment variables.
+
+| Key | Description |
+| --- | --- |
+| `KREDITS_WEBHOOK_TOKEN` | A string for building your secret webhook URLs |
+| `KREDITS_ROOM` | The bot will talk to you in this room |
+| `KREDITS_WALLET_PATH` | Path to an Etherum wallet JSON file (default: `./wallet.json`) |
+| `KREDITS_WALLET_PASSWORD` | Wallet password |
+| `KREDITS_PROVIDER_URL` | Ethereum JSON-RPC URL (default: `http://localhost:7545`) |
+| `KREDITS_WEB_URL` | URL of the Kredits Web app (default: `https://kredits.kosmos.org`) |
+| `KREDITS_DAO_ADDRESS` | DAO Kernel address |
+| `KREDITS_SESSION_SECRET` | Secret used by [grant](https://www.npmjs.com/package/grant) to sign the session ID |
+| `KREDITS_GRANT_HOST` | Host used by [grant](https://www.npmjs.com/package/grant) to generate OAuth redirect URLs (default: `localhost:8888`) |
+| `KREDITS_GRANT_PROTOCOL` | Protocol (http or https) used by [grant](https://www.npmjs.com/package/grant") to generate the OAuth redirect URLs (default: "http") |
+
+## Integrations
+
+### GitHub
+
+The GitHub integration will watch for closed issues and merged pull requests,
+which carry a kredits label: `kredits-1`, `kredits-2`, `kredits-3` for small,
+medium and large contributions. If there are multiple people assigned, it will
+issue contribution tokens for all of them.
+
+If `KREDITS_GITHUB_KEY` and `KREDITS_GITHUB_SECRET` are set, the bot will also
+expose OAuth endpoints to authenticate new contributors and register new
+contributor profiles on the smart contract. For this feature, a [GitHub OAuth
+app] is required and the [OAuth grant config variables](#Configuration) must be
+set.
+
+#### Setup
+
+Point a GitHub organization webhook to the following URL:
+
+    https://your-hubot.example.com/incoming/kredits/github/{webhook_token}
+
+#### Config
+
+| Key | Description |
+| --- | --- |
+| `KREDITS_GITHUB_REPO_BLACKLIST` | Repos which you do not want to issue kredits for. Format: `orgname/reponame`, e.g. `67P/test-one-two` |
+| `KREDITS_GITHUB_KEY` | Key of the [GitHub OAuth app] used to authenticate contributors |
+| `KREDITS_GITHUB_SECRET` | Secret of the [GitHub OAuth app] used to authenticate contributors |
+
+### Gitea
+
+The Gitea integration will watch for closed issues and merged pull requests,
+which carry a kredits label: `kredits-1`, `kredits-2`, `kredits-3` for small,
+medium and large contributions. If there are multiple people assigned, it will
+issue contribution tokens for all of them.
+
+#### Setup
+
+Point a Gitea organization webhook to the following URL:
+
+    https://your-hubot.example.com/incoming/kredits/gitea/{webhook_token}
+
+#### Config
+
+| Key | Description |
+| --- | --- |
+| `KREDITS_GITEA_REPO_BLACKLIST` | Repos which you do not want to issue kredits for. Format: `orgname/reponame`, e.g. `kosmos/test-one-two` |
+
+### MediaWiki
+
+The MediaWiki integration will periodically check for wiki page creations and
+edits. It will create kredits contribution tokens based on amount of text added.
+
+#### Setup
+
+No setup needed, except for configuring the wiki URL. The bot will poll your
+wiki's API on its own.
+
+#### Config
+
+| Key | Description |
+| --- | --- |
+| `KREDITS_MEDIAWIKI_URL` | Your wiki URL, e.g. `https://wiki.kosmos.org/` |
+
+[kredits-contracts]: https://github.com/67P/kredits-contracts
+[GitHub OAuth app]: https://developer.github.com/apps/about-apps/#about-oauth-apps

index.js

@@ -1,363 +1,159 @@
-// Description:
-//   Kosmos Kredits chat integration
-//
-// Configuration:
-//   KREDITS_WEBHOOK_TOKEN: A string for building your secret webhook URL
-//   KREDITS_ROOM: Kredit proposals are posted to this chatroom
-//   KREDITS_WALLET_PATH: Path to a etherum wallet JSON file
-//   KREDITS_WALLET_PASSWORD: Wallet password
-//   KREDITS_CONTRACT_ADDRESS: Address of Kredits contract
-//   KREDITS_PROVIDER_URL: Ethereum JSON-RPC URL (default 'http://localhost:8545')
-//   IPFS_API_HOST: Host/domain (default 'localhost')
-//   IPFS_API_PORT: Port number (default '5001')
-//   IPFS_API_PROTOCOL: Protocol, e.g. 'http' or 'https' (default 'http')
-//
 const fs = require('fs');
 const util = require('util');
 const fetch = require('node-fetch');
-const kreditsContracts = require('kredits-contracts');
-const ProviderEngine = require('web3-provider-engine');
-const Wallet = require('ethereumjs-wallet');
-const WalletSubprovider = require('ethereumjs-wallet/provider-engine');
-const Web3Subprovider = require('web3-provider-engine/subproviders/web3.js');
-const Web3 = require('web3');
-const ipfsAPI = require('ipfs-api');
-const schemas = require('kosmos-schemas');
-const tv4 = require('tv4');
+const ethers = require('ethers');
+const Kredits = require('kredits-contracts');
 
-(function() {
-  "use strict";
+const walletPath  = process.env.KREDITS_WALLET_PATH || './wallet.json';
+const walletJson  = fs.readFileSync(walletPath);
+const providerUrl = process.env.KREDITS_PROVIDER_URL;
+const daoAddress  = process.env.KREDITS_DAO_ADDRESS;
 
-  //
-  // Instantiate ethereum client and wallet
-  //
-  let engine = new ProviderEngine();
+const ipfsConfig = {
+  host: process.env.IPFS_API_HOST || 'localhost',
+  port: process.env.IPFS_API_PORT || '5001',
+  protocol: process.env.IPFS_API_PROTOCOL || 'http'
+};
 
-  let walletPath  = process.env.KREDITS_WALLET_PATH || './wallet.json';
-  let walletJson  = fs.readFileSync(walletPath);
-  let wallet      = Wallet.fromV3(JSON.parse(walletJson), process.env.KREDITS_WALLET_PASSWORD);
-  let providerUrl = process.env.KREDITS_PROVIDER_URL || 'http://localhost:8545';
-  let hubotWalletAddress = '0x' + wallet.getAddress().toString('hex');
+module.exports = async function(robot) {
 
-  engine.addProvider(new WalletSubprovider(wallet, {}));
-  engine.addProvider(new Web3Subprovider(new Web3.providers.HttpProvider(providerUrl)));
-  // TODO only start engine if providerURL is accessible
-  engine.start();
-
-  let web3 = new Web3(engine);
-  web3.eth.defaultAccount = hubotWalletAddress;
-
-  //
-  // Instantiate contracts
-  //
-  let contractConfig = {};
-  if (process.env.KREDITS_CONTRACT_ADDRESS) {
-    contractConfig = { Kredits: { address: process.env.KREDITS_CONTRACT_ADDRESS }};
+  function messageRoom(message) {
+    robot.messageRoom(process.env.KREDITS_ROOM, message);
   }
-  let contracts = kreditsContracts(web3, contractConfig);
-  let kredits = contracts['Kredits'];
 
   //
-  // Instantiate IPFS API client
+  // Ethereum wallet setup
   //
-  let ipfsConfig = {};
-  if (process.env.IPFS_API_HOST) {
-    ipfsConfig = {
-      host: process.env.IPFS_API_HOST,
-      port: process.env.IPFS_API_PORT,
-      protocol: process.env.IPFS_API_PROTOCOL
-    };
+
+  let wallet;
+  try {
+    wallet = await ethers.Wallet.fromEncryptedJson(walletJson, process.env.KREDITS_WALLET_PASSWORD);
+  } catch(error) {
+    robot.logger.warning('[hubot-kredits] Could not load wallet:', error);
+    process.exit(1);
   }
-  let ipfs = ipfsAPI(ipfsConfig);
 
-  module.exports = function(robot) {
+  //
+  // Ethereum provider/node setup
+  //
 
-    robot.logger.info('[hubot-kredits] Wallet address: ' + hubotWalletAddress);
+  let ethProvider;
+  if (providerUrl) {
+    ethProvider = new ethers.providers.JsonRpcProvider(providerUrl);
+  } else {
+    ethProvider = new ethers.getDefaultProvider('rinkeby');
+  }
+  const signer = wallet.connect(ethProvider);
 
-    getBalance().then(balance => {
-      if (balance <= 0) {
-        messageRoom(`Yo gang, I\'m broke! Please drop me some ETH to ${hubotWalletAddress}. kthxbai.`);
-      }
+  //
+  // Kredits contracts setup
+  //
+
+  const opts = { ipfsConfig };
+  if (daoAddress) {
+    opts.addresses = { Kernel: daoAddress };
+  }
+  let kredits;
+
+  try {
+    kredits = await new Kredits(signer.provider, signer, opts).init();
+  } catch(error) {
+    robot.logger.warning('[hubot-kredits] Could not set up kredits:', error);
+    process.exit(1);
+  }
+  const Contributor = kredits.Contributor;
+  const Proposal = kredits.Proposal;
+  const Contribution = kredits.Contribution;
+
+  robot.logger.info('[hubot-kredits] Wallet address: ' + wallet.address);
+
+  //
+  // Check robot's wallet balance and alert when it's broke
+  //
+
+  ethProvider.getBalance(wallet.address).then(balance => {
+    robot.logger.info('[hubot-kredits] Wallet balance: ' + ethers.utils.formatEther(balance) + 'ETH');
+    if (balance.lt(ethers.utils.parseEther('0.0001'))) {
+      messageRoom(`Yo gang, I\'m broke! Please drop me some ETH to ${wallet.address}. kthxbai.`);
+    }
+  });
+
+  //
+  // Robot chat commands/interaction
+  //
+
+  robot.respond(/got ETH\??/i, res => {
+    ethProvider.getBalance(wallet.address).then((balance) => {
+      res.send(`My wallet contains ${ethers.utils.formatEther(balance)} ETH`);
     });
+  });
 
-    function getBalance() {
-      return new Promise((resolve, reject) => {
-        web3.eth.getBalance(hubotWalletAddress, function (err, balance) {
-          if (err) {
-            robot.logger.error('[hubot-kredits] Error checking balance');
-            reject(err);
-            return;
-          }
-          resolve(balance);
-        });
-      });
-    }
+  robot.respond(/propose (\d*)\s?\S*\s?to (\S+)(?:\sfor (.*))?$/i, res => {
+    let [_, amount, githubUser, description] = res.match;
+    let url = null;
+    createProposal(githubUser, amount, description, url).then((result) => {
+      messageRoom('Sounds good! Will be listed on https://kredits.kosmos.org in a bit...');
+    });
+  });
 
-    function getValueFromContract(contractMethod, ...args) {
-      return new Promise((resolve, reject) => {
-        kredits[contractMethod](...args, (err, data) => {
-          if (err) { reject(err); }
-          resolve(data);
-        });
-      });
-    }
-
-    function loadProfileFromIPFS(contributor) {
-      let promise = new Promise((resolve, reject) => {
-        return ipfs.cat(contributor.ipfsHash, { buffer: true }).then(res => {
-          let content = res.toString();
-          let profile = JSON.parse(content);
-
-          contributor.name = profile.name;
-          contributor.kind = profile.kind;
-
-          let accounts = profile.accounts;
-          let github   = accounts.find(a => a.site === 'github.com');
-          let wiki     = accounts.find(a => a.site === 'wiki.kosmos.org');
-
-          if (github) {
-            contributor.github_username = github.username;
-            contributor.github_uid = github.uid;
-          }
-          if (wiki) {
-            contributor.wiki_username = wiki.username;
-          }
-
-          resolve(contributor);
-        }).catch((err) => {
-          console.log(err);
-          reject(err);
-        });
-      });
-
-      return promise;
-    }
-
-    function getContributorData(i) {
-      let promise = new Promise((resolve, reject) => {
-        getValueFromContract('contributorAddresses', i).then(address => {
-          robot.logger.debug('address', address);
-          getValueFromContract('contributors', address).then(person => {
-            robot.logger.debug('person', person);
-            let c = {
-              address: address,
-              name: person[1],
-              id: person[0],
-              ipfsHash: person[2]
-            };
-            if (c.ipfsHash) {
-              loadProfileFromIPFS(c).then(contributor => {
-                robot.logger.debug('[kredits] contributor', contributor);
-                resolve(contributor);
-              }).catch(() => console.log('[kredits] error fetching contributor info from IPFS for '+c.name));
-            } else {
-              resolve(c);
-            }
+  robot.respond(/list open proposals/i, res => {
+    Proposal.all().then((proposals) => {
+      proposals.forEach((proposal) => {
+        if (!proposal.executed) {
+          Contributor.getById(proposal.contributorId).then((contributor) => {
+            messageRoom(`* ${proposal.amount} kredits to ${contributor.name} for ${proposal.description}`);
           });
-        }).catch(err => reject(err));
-      });
-      return promise;
-    }
-
-    function getContributors() {
-      return getValueFromContract('contributorsCount').then(contributorsCount => {
-        let contributors = [];
-
-        for(var i = 0; i < contributorsCount.toNumber(); i++) {
-          contributors.push(getContributorData(i));
         }
-
-        return Promise.all(contributors);
       });
-    }
+      messageRoom('https://kredits.kosmos.org');
+    });
+  });
 
-    function getContributorByGithubUser(username) {
-      let promise = new Promise((resolve, reject) => {
-        getContributors().then(contributors => {
-          let contrib = contributors.find(c => {
-            return c.github_username === username;
-          });
-          if (contrib) {
-            resolve(contrib);
-          } else {
-            reject();
-          }
-        });
-      });
-      return promise;
-    }
+  //
+  // Smart contract events
+  //
 
-    function messageRoom(message) {
-      robot.messageRoom(process.env.KREDITS_ROOM, message);
-    }
+  function watchContractEvents() {
+    ethProvider.getBlockNumber().then((blockNumber) => {
+      // current block is the last mined one, thus we check from the next
+      // mined one onwards to prevent getting previous events
+      let nextBlock = blockNumber + 1;
+      robot.logger.debug(`[hubot-kredits] Watching events from block ${nextBlock} onward`);
+      ethProvider.resetEventsBlock(nextBlock);
 
-    function amountFromIssueLabels(issue) {
-      let kreditsLabel = issue.labels.map(l => l.name)
-                              .filter(n => n.match(/^kredits/))[0];
-      // No label, no kredits
-      if (typeof kreditsLabel === 'undefined') { return 0; }
+      Proposal.on('ProposalCreated', handleProposalCreated);
+      Contribution.on('ContributionAdded', handleContributionAdded);
+    });
+  }
 
-      // TODO move to config maybe?
-      let amount;
-      switch(kreditsLabel) {
-        case 'kredits-1':
-          amount = 50;
-          break;
-        case 'kredits-2':
-          amount = 150;
-          break;
-        case 'kredits-3':
-          amount = 500;
-          break;
-      }
-
-      return amount;
-    }
-
-    function createContributionDocument(contributor, url, description, details) {
-      let contribution = {
-        "@context": "https://schema.kosmos.org",
-        "@type": "Contribution",
-        contributor: {
-          ipfs: contributor.ipfsHash
-        },
-        kind: 'dev',
-        url: url,
-        description: description,
-        details: details
-      };
-
-      if (! tv4.validate(contribution, schemas["contribution"])) {
-        console.log('[kredits] invalid contribution data: ', util.inspect(contribution));
-        return Promise.reject('invalid contribution data');
-      }
-
-      return ipfs.add(new ipfs.Buffer(JSON.stringify(contribution)))
-        .then(res => { return res[0].hash; })
-        .catch(err => console.log(err));
-    }
-
-    function createProposal(recipient, amount, url, description, details) {
-      robot.logger.debug(`Creating proposal to issue ${amount}₭S to ${recipient} for ${url}...`);
-
-      return new Promise((resolve, reject) => {
-        // Get contributor details for GitHub user
-        getContributorByGithubUser(recipient).then(c => {
-          // Create document containing contribution data on IPFS
-          createContributionDocument(c, url, description, details).then(ipfsHash => {
-            // Create proposal on ethereum blockchain
-            kredits.addProposal(c.address, amount, url, ipfsHash, (e/* , d */) => {
-              if (e) { reject(e); return; }
-              messageRoom(`Let's give ${recipient} some kredits for ${url}: https://kredits.kosmos.org`);
-            });
-          });
-        }, () => {
-          messageRoom(`I wanted to propose giving kredits to ${recipient} for ${url}, but I can't find their contact data. Please add them as a contributor: https://kredits.kosmos.org`);
-        });
-
-        resolve();
-      });
-    }
-
-    function handleGitHubIssueClosed(data) {
-      return new Promise((resolve/*, reject*/) => {
-        // fs.writeFileSync('tmp/github-issue.json', JSON.stringify(data, null, 4));
-        let recipients;
-        let issue        = data.issue;
-        let assignees    = issue.assignees.map(a => a.login);
-        let web_url      = issue.html_url;
-
-        let amount = amountFromIssueLabels(issue);
-        if (amount === 0) { resolve(); return; }
-
-        if (assignees.length > 0) {
-          recipients = assignees;
-        } else {
-          recipients = [issue.user.login];
-        }
-
-        let repoName = issue.repository_url.match(/.*\/(.+\/.+)$/)[1];
-        let description = `${repoName}: ${issue.title}`;
-
-        recipients.forEach(recipient => {
-          createProposal(recipient, amount, web_url, description, issue);
-        });
-
-        resolve();
-      });
-    }
-
-    function handleGitHubPullRequestClosed(data) {
-      return new Promise((resolve, reject) => {
-        // fs.writeFileSync('tmp/github-pr.json', JSON.stringify(data, null, 4));
-        let recipients;
-        let pull_request = data.pull_request;
-        let assignees    = pull_request.assignees.map(a => a.login);
-        let web_url      = pull_request._links.html.href;
-        let pr_issue_url = pull_request.issue_url;
-
-        if (assignees.length > 0) {
-          recipients = assignees;
-        } else {
-          recipients = [pull_request.user.login];
-        }
-
-        fetch(pr_issue_url)
-          .then(response => {
-            if (response.status >= 400) {
-              reject('Bad response from fetching PR issue');
-            }
-            return response.json();
-          })
-          .then(issue => {
-            // fs.writeFileSync('tmp/github-pr-issue.json', JSON.stringify(data, null, 4));
-            let amount = amountFromIssueLabels(issue);
-            if (amount === 0) { resolve(); return; }
-
-            let repoName = pull_request.base.repo.full_name;
-            let description = `${repoName}: ${pull_request.title}`;
-
-            recipients.forEach(recipient => {
-              createProposal(recipient, amount, web_url, description, pull_request);
-            });
-
-            resolve();
-          });
-      });
-    }
-
-    robot.respond(/(got ETH)|(got gas)\?/i, res => {
-      getBalance().then(balance => {
-        if (balance <= 0) {
-          res.send(`HALP, I\'m totally broke! Not a single wei in my pocket.`);
-        }
-        else if (balance >= 1e+17) {
-          res.send(`my wallet contains ${web3.fromWei(balance, 'ether')} ETH`);
-        }
-        else {
-          res.send(`I\'m almost broke! Only have ${web3.fromWei(balance, 'ether')} ETH left in my pocket. :(`);
-        }
+  function handleProposalCreated(proposalId, creatorAccount, contributorId, amount) {
+    Contributor.getById(contributorId).then((contributor) => {
+      Proposal.getById(proposalId).then((proposal) => {
+        robot.logger.debug(`[hubot-kredits] Proposal created (${proposal.description})`);
+        // messageRoom(`Let's give ${contributor.name} some kredits for ${proposal.url} (${proposal.description}): https://kredits.kosmos.org`);
       });
     });
+  }
 
-    robot.router.post('/incoming/kredits/github/'+process.env.KREDITS_WEBHOOK_TOKEN, (req, res) => {
-      let evt = req.header('X-GitHub-Event');
-      let data = req.body;
-      // For some reason data is contained in a payload property on one
-      // machine, but directly in the root of the object on others
-      if (data.payload) { data = JSON.parse(data.payload); }
-
-      robot.logger.info(`Received GitHub hook. Event: ${evt}, action: ${data.action}`);
-
-      if (evt === 'pull_request' && data.action === 'closed') {
-        handleGitHubPullRequestClosed(data).then(() => res.send(200));
-      }
-      else if (evt === 'issues' && data.action === 'closed') {
-        handleGitHubIssueClosed(data).then(() => res.send(200));
-      } else {
-        res.send(200);
-      }
+  function handleContributionAdded(contributionId, contributorId, amount) {
+    Contributor.getById(contributorId).then((contributor) => {
+      Contribution.getById(contributionId).then((contribution) => {
+        robot.logger.debug(`[hubot-kredits] Contribution #${contribution.id} added (${contribution.description})`);
+      });
     });
+  }
 
-  };
-}());
+  watchContractEvents();
+
+  //
+  // Integrations
+  //
+
+  require('./integrations/github')(robot, kredits);
+  require('./integrations/gitea')(robot, kredits);
+
+  if (typeof process.env.KREDITS_MEDIAWIKI_URL !== 'undefined') {
+    require('./integrations/mediawiki')(robot, kredits);
+  }
+
+};

integrations/gitea.js

@@ -0,0 +1,166 @@
+const util = require('util');
+const fetch = require('node-fetch');
+const amountFromLabels = require('./utils/amount-from-labels');
+const kindFromLabels = require('./utils/kind-from-labels');
+
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+module.exports = async function(robot, kredits) {
+
+  function messageRoom(message) {
+    robot.messageRoom(process.env.KREDITS_ROOM, message);
+  }
+
+  robot.logger.debug('[hubot-kredits] Loading Gitea integration...');
+
+  let repoBlackList = [];
+  if (process.env.KREDITS_GITEA_REPO_BLACKLIST) {
+    repoBlackList = process.env.KREDITS_GITEA_REPO_BLACKLIST.split(',');
+    robot.logger.debug('[hubot-kredits] Ignoring Gitea actions from ', util.inspect(repoBlackList));
+  }
+
+  const Contributor = kredits.Contributor;
+  const Contribution = kredits.Contribution;
+
+  function getContributorByGiteaUser(username) {
+    return Contributor.all().then(contributors => {
+      const contrib = contributors.find(c => {
+        return c.gitea_username === username;
+      });
+      if (!contrib) {
+        throw new Error(`No contributor found for ${username}`);
+      } else {
+        return contrib;
+      }
+    });
+  }
+
+  function createContribution(giteaUser, date, time, amount, kind, description, url, details) {
+    return getContributorByGiteaUser(giteaUser).then(contributor => {
+      robot.logger.debug(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${giteaUser} for ${url}...`);
+
+      const contributionAttr = {
+        contributorId: contributor.id,
+        contributorIpfsHash: contributor.ipfsHash,
+        date,
+        time,
+        amount,
+        kind,
+        description,
+        url,
+        details
+      };
+
+      robot.logger.debug(`[hubot-kredits] contribution attributes:`);
+      robot.logger.debug(util.inspect(contributionAttr, { depth: 1, colors: true }));
+
+      return Contribution.addContribution(contributionAttr).catch(error => {
+        robot.logger.error(`[hubot-kredits] Error:`, error);
+        messageRoom(`I tried to add a contribution for ${giteaUser} for ${url}, but I encountered an error when submitting the tx:`);
+        messageRoom(error.message);
+      });
+    });
+  }
+
+  async function handleGiteaIssueClosed(data) {
+    const issue       = data.issue;
+    const repoName    = data.repository.full_name;
+    const web_url     = `${data.repository.html_url}/issues/${issue.number}`;
+    const description = `${repoName}: ${issue.title}`;
+    const labels      = issue.labels.map(l => l.name);
+    const amount      = amountFromLabels(labels);
+    const kind        = kindFromLabels(labels);
+    const assignees   = issue.assignees ? issue.assignees.map(a => a.login) : [];
+    [ date, time ]    = issue.closed_at.split('T');
+
+    if (amount === 0) {
+      robot.logger.info('[hubot-kredits] Kredits amount from issue label is zero; ignoring');
+      return Promise.resolve();
+    } else if (repoBlackList.includes(repoName)) {
+      robot.logger.debug(`[hubot-kredits] ${repoName} is on black list; ignoring`);
+      return Promise.resolve();
+    }
+
+    let recipients;
+    if (assignees.length > 0) {
+      recipients = assignees;
+    } else {
+      recipients = [issue.user.login];
+    }
+
+    for (const recipient of recipients) {
+      try {
+        await createContribution(recipient, date, time, amount,
+                                 kind, description, web_url,
+                                 { issue, repository: data.repository });
+        await sleep(60000);
+      }
+      catch (err) { robot.logger.error(err); }
+    }
+
+    return Promise.resolve();
+  }
+
+  async function handleGiteaPullRequestClosed(data) {
+    const pull_request = data.pull_request;
+    const repoName     = data.repository.full_name;
+    const web_url      = pull_request.html_url;
+    const description  = `${repoName}: ${pull_request.title}`;
+    const labels      = pull_request.labels.map(l => l.name);
+    const amount      = amountFromLabels(labels);
+    const kind        = kindFromLabels(labels);
+    const assignees    = pull_request.assignees ? pull_request.assignees.map(a => a.login) : [];
+    [ date, time ]     = pull_request.merged_at.split('T');
+
+    if (amount === 0) {
+      robot.logger.info('[hubot-kredits] Kredits amount from issue label is zero; ignoring');
+      return Promise.resolve();
+    } else if (repoBlackList.includes(repoName)) {
+      robot.logger.debug(`[hubot-kredits] ${repoName} is on black list; ignoring`);
+      return Promise.resolve();
+    }
+
+    let recipients;
+    if (assignees.length > 0) {
+      recipients = assignees;
+    } else {
+      recipients = [pull_request.user.login];
+    }
+
+    for (const recipient of recipients) {
+      try {
+        await createContribution(recipient, date, time, amount,
+                                 kind, description, web_url,
+                                 { pull_request, repository: data.repository });
+        await sleep(60000);
+      }
+      catch (err) { robot.logger.error(err); }
+    }
+
+    return Promise.resolve();
+  }
+
+  robot.router.post('/incoming/kredits/gitea/'+process.env.KREDITS_WEBHOOK_TOKEN, (req, res) => {
+    const evt = req.header('X-Gitea-Event');
+    let data = req.body;
+    // For some reason data is contained in a payload property on one
+    // machine, but directly in the root of the object on others
+    if (data.payload) { data = JSON.parse(data.payload); }
+
+    robot.logger.info(`Received Gitea hook. Event: ${evt}, action: ${data.action}`);
+
+    if (evt === 'pull_request' && data.action === 'closed' && data.pull_request.merged) {
+      handleGiteaPullRequestClosed(data);
+      res.sendStatus(200);
+    }
+    else if (evt === 'issues' && data.action === 'closed') {
+      handleGiteaIssueClosed(data);
+      res.sendStatus(200);
+    } else {
+      res.sendStatus(200);
+    }
+  });
+
+};

integrations/github.js

@@ -0,0 +1,277 @@
+const util = require('util');
+const fetch = require('node-fetch');
+const session = require('express-session');
+const grant = require('grant-express');
+const cors = require('cors');
+const amountFromLabels = require('./utils/amount-from-labels');
+const kindFromLabels = require('./utils/kind-from-labels');
+
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+module.exports = async function(robot, kredits) {
+
+  function messageRoom(message) {
+    robot.messageRoom(process.env.KREDITS_ROOM, message);
+  }
+
+  robot.logger.debug('[hubot-kredits] Loading GitHub integration...');
+
+  let repoBlackList = [];
+  if (process.env.KREDITS_GITHUB_REPO_BLACKLIST) {
+    repoBlackList = process.env.KREDITS_GITHUB_REPO_BLACKLIST.split(',');
+    robot.logger.debug('[hubot-kredits] Ignoring GitHub actions from ', util.inspect(repoBlackList));
+  }
+
+  const kreditsWebUrl = process.env.KREDITS_WEB_URL || 'https://kredits.kosmos.org';
+
+  const Contributor = kredits.Contributor;
+  const Contribution = kredits.Contribution;
+
+  function getContributorByGithubUser(username) {
+    return Contributor.all().then(contributors => {
+      const contrib = contributors.find(c => {
+        return c.github_username === username;
+      });
+      if (!contrib) {
+        throw new Error(`No contributor found for ${username}`);
+      } else {
+        return contrib;
+      }
+    });
+  }
+
+  function createContribution(githubUser, date, time, amount, kind, description, url, details) {
+    return getContributorByGithubUser(githubUser).then(contributor => {
+      robot.logger.info(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${githubUser} for ${url}...`);
+
+      const contributionAttr = {
+        contributorId: contributor.id,
+        contributorIpfsHash: contributor.ipfsHash,
+        date,
+        time,
+        amount,
+        kind,
+        description,
+        url,
+        details
+      };
+
+      robot.logger.debug(`[hubot-kredits] contribution attributes:`);
+      robot.logger.debug(util.inspect(contributionAttr, { depth: 1, colors: true }));
+
+      return Contribution.addContribution(contributionAttr).catch(error => {
+        robot.logger.error(`[hubot-kredits] Error:`, error);
+        messageRoom(`I tried to add a contribution for ${githubUser} for ${url}, but I encountered an error when submitting the tx:`);
+        messageRoom(error.message);
+      });
+    });
+  }
+
+  async function handleGitHubIssueClosed(data) {
+    let recipients;
+    const issue       = data.issue;
+    const assignees   = issue.assignees.map(a => a.login);
+    const web_url     = issue.html_url;
+
+    [date, time]      = issue.closed_at.split('T');
+    const labels      = issue.labels.map(l => l.name);
+    const amount      = amountFromLabels(labels);
+    const kind        = kindFromLabels(labels);
+    const repoName    = issue.repository_url.match(/.*\/(.+\/.+)$/)[1];
+    const description = `${repoName}: ${issue.title}`;
+
+    if (amount === 0) {
+      robot.logger.info('[hubot-kredits] Kredits amount from issue label is zero; ignoring');
+      return Promise.resolve();
+    } else if (repoBlackList.includes(repoName)) {
+      robot.logger.debug(`[hubot-kredits] ${repoName} is on black list; ignoring`);
+      return Promise.resolve();
+    }
+
+    if (assignees.length > 0) {
+      recipients = assignees;
+    } else {
+      recipients = [issue.user.login];
+    }
+
+    for (const recipient of recipients) {
+      try {
+        await createContribution(recipient, date, time, amount, kind, description, web_url, issue);
+        await sleep(60000);
+      }
+      catch (err) { robot.logger.error(err); }
+    }
+
+    return Promise.resolve();
+  }
+
+  function handleGitHubPullRequestClosed(data) {
+    let recipients;
+    const pull_request = data.pull_request;
+    const assignees    = pull_request.assignees.map(a => a.login);
+    const web_url      = pull_request._links.html.href;
+    const pr_issue_url = pull_request.issue_url;
+
+    [date, time] = pull_request.merged_at.split('T');
+
+    if (assignees.length > 0) {
+      recipients = assignees;
+    } else {
+      recipients = [pull_request.user.login];
+    }
+
+    return fetch(pr_issue_url)
+      .then(response => {
+        if (response.status >= 400) {
+          throw new Error('Bad response from fetching PR issue');
+        }
+        return response.json();
+      })
+      .then(async (issue) => {
+        const labels      = issue.labels.map(l => l.name);
+        const amount      = amountFromLabels(labels);
+        const kind        = kindFromLabels(labels);
+        const repoName    = pull_request.base.repo.full_name;
+        const description = `${repoName}: ${pull_request.title}`;
+
+        if (amount === 0) {
+          robot.logger.info('[hubot-kredits] Kredits amount from issue label is zero; ignoring');
+          return Promise.resolve();
+        } else if (repoBlackList.includes(repoName)) {
+          robot.logger.debug(`[hubot-kredits] ${repoName} is on black list; ignoring`);
+          return Promise.resolve();
+        }
+
+        for (const recipient of recipients) {
+          try {
+            await createContribution(recipient, date, time, amount, kind, description, web_url, pull_request);
+            await sleep(60000);
+          }
+          catch (err) { robot.logger.error(err); }
+        }
+
+        return Promise.resolve();
+      });
+  }
+
+  robot.router.post('/incoming/kredits/github/'+process.env.KREDITS_WEBHOOK_TOKEN, (req, res) => {
+    const evt = req.header('X-GitHub-Event');
+    let data = req.body;
+    // For some reason data is contained in a payload property on one
+    // machine, but directly in the root of the object on others
+    if (data.payload) { data = JSON.parse(data.payload); }
+
+    robot.logger.info(`Received GitHub hook. Event: ${evt}, action: ${data.action}`);
+
+    if (evt === 'pull_request' && data.action === 'closed' && data.pull_request.merged) {
+      handleGitHubPullRequestClosed(data);
+      res.sendStatus(200);
+    }
+    else if (evt === 'issues' && data.action === 'closed') {
+      handleGitHubIssueClosed(data);
+      res.sendStatus(200);
+    } else {
+      res.sendStatus(200);
+    }
+  });
+
+  //
+  // GitHub signup
+  //
+
+  if (process.env.KREDITS_GITHUB_KEY && process.env.KREDITS_GITHUB_SECRET) {
+    const grantConfig = {
+      defaults: {
+        protocol: (process.env.KREDITS_GRANT_PROTOCOL || "http"),
+        host: (process.env.KREDITS_GRANT_HOST || 'localhost:8888'),
+        transport: 'session',
+        response: 'tokens',
+        path: '/kredits/signup'
+      },
+      github: {
+        key: process.env.KREDITS_GITHUB_KEY,
+        secret: process.env.KREDITS_GITHUB_SECRET,
+        callback: '/kredits/signup/github'
+      }
+    };
+
+    robot.router.use(session({
+      secret: process.env.KREDITS_SESSION_SECRET || 'grant',
+      resave: false,
+      saveUninitialized: false
+    }));
+
+    robot.router.use('/kredits/signup', grant(grantConfig));
+
+    robot.router.get('/kredits/signup/github', async (req, res) => {
+      const access_token = req.session.grant.response.access_token;
+
+      res.redirect(`${kreditsWebUrl}/signup/github#access_token=${access_token}`);
+    });
+
+    robot.router.options('/kredits/signup/github', cors());
+
+    robot.router.post('/kredits/signup/github', cors(), async (req, res) => {
+      const accessToken = req.body.accessToken;
+      if (!accessToken) {
+        res.status(400).json({});
+        return;
+      }
+      let githubResponse;
+      try {
+        githubResponse = await fetch('https://api.github.com/user', {
+          headers: {
+            'Accept': 'application/vnd.github.v3+json',
+            'Authorization': `token ${accessToken}`
+          }
+        });
+      } catch (error) {
+        robot.logger.error('[hubot-kredits] Fetching user data from GitHub failed:', error);
+        res.status(500).json({ error });
+      };
+
+      if (githubResponse.status >= 300) {
+        res.status(githubResponse.status).json({});
+        return;
+      }
+      const user = await githubResponse.json();
+
+      const contributor = await kredits.Contributor.findByAccount({
+        site: 'github.com',
+        username: user.login
+      });
+
+      if (!contributor) {
+        let contributorAttr = {};
+        contributorAttr.account = req.body.account;
+        contributorAttr.name = user.name || user.login;
+        contributorAttr.kind = "person";
+        contributorAttr.url = user.blog;
+        contributorAttr.github_username = user.login;
+        contributorAttr.github_uid = user.id;
+
+        kredits.Contributor.add(contributorAttr, { gasLimit: 350000 })
+          .then(transaction => {
+            robot.logger.info('[hubot-kredits] Contributor added from GitHub signup', transaction.hash);
+            res.status(201);
+            res.json({
+              transactionHash: transaction.hash,
+              github_username: user.login
+            });
+          }, error => {
+            robot.logger.error(`[hubot-kredits] Adding contributor failed: ${error}`);
+            res.status(422);
+            res.json({ error })
+          });
+      } else {
+        res.json({
+          github_username: user.login
+        });
+      }
+    });
+  } else {
+    robot.logger.warning('[hubot-kredits] No KREDITS_GITHUB_KEY and KREDITS_GITHUB_SECRET configured for OAuth signup');
+  }
+};

integrations/mediawiki.js

@@ -0,0 +1,185 @@
+const url = require('url');
+const util = require('util');
+const fetch = require('node-fetch');
+const groupArray = require('group-array');
+const cron = require('node-cron');
+
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+module.exports = async function(robot, kredits) {
+
+  function messageRoom(message) {
+    robot.messageRoom(process.env.KREDITS_ROOM, message);
+  }
+
+  robot.logger.debug('[hubot-kredits] Loading MediaWiki integration...')
+
+  const Contributor = kredits.Contributor;
+  const Contribution = kredits.Contribution;
+
+  const wikiURL = process.env.KREDITS_MEDIAWIKI_URL;
+  const apiURL =  wikiURL + 'api.php';
+
+  function getContributorByWikiUser(username) {
+    let account = {
+      site: url.parse(process.env.KREDITS_MEDIAWIKI_URL).hostname,
+      username: username
+    }
+    return Contributor.findByAccount(account).then(contributor => {
+      robot.logger.debug('CONTRIBUTOR: ', contributor)
+      if (contributor) { return contributor; } else { throw new Error(); }
+    });
+  }
+
+  function createContribution(username, date, amount, description, url, details={}) {
+    return getContributorByWikiUser(username).then(contributor => {
+      robot.logger.debug(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${contributor.name} for ${url}...`);
+
+      let contribution = {
+        contributorId: contributor.id,
+        contributorIpfsHash: contributor.ipfsHash,
+        date,
+        amount: amount,
+        url,
+        description,
+        details,
+        kind: 'docs'
+      };
+
+      return Contribution.addContribution(contribution).catch(error => {
+        robot.logger.error(`[hubot-kredits] Adding contribution failed:`, error);
+      });
+    }).catch(() => {
+        robot.logger.info(`[hubot-kredits] No contributor found for ${username}`);
+        messageRoom(`I wanted to propose giving kredits to wiki user ${username}, but I cannot find their info. Please add them as a contributor: https://kredits.kosmos.org`);
+    });
+  }
+
+  function fetchChanges () {
+    const params = [
+      'action=query',
+      'format=json',
+      'list=recentchanges',
+      'rctype=edit|new',
+      'rcshow=!minor|!bot|!anon|!redirect',
+      'rclimit=max',
+      'rcprop=ids|title|timestamp|user|sizes|comment|flags'
+    ];
+
+    let endTime = robot.brain.get('kredits:mediawiki:last_processed_at');
+    if (endTime) {
+      robot.logger.debug(`[hubot-kredits] Fetching wiki edits since ${endTime}`);
+      params.push(`rcend=${endTime}`);
+    }
+
+    const url = `${apiURL}?${params.join('&')}`;
+
+    return fetch(url).then(res => {
+      if (res.status === 200) {
+        return res.json();
+      } else {
+        robot.logger.info(`Fetching ${url} returned HTTP status ${res.status}:`);
+        robot.logger.info(res.body);
+        throw Error('Unexpected response from '+url);
+      }
+    }).then(res => {
+      return res.query.recentchanges;
+    }).catch(res => {
+      robot.logger.error(`[hubot-kredits] Failed to fetch ${url} (likely due to a network issue)`);
+    });
+  }
+
+  function groupChangesByUser (changes) {
+    return Promise.resolve(groupArray(changes, 'user'));
+  }
+
+  function analyzeUserChanges (user, changes) {
+    // robot.logger.debug(`Analyzing ${changes.length} edits from ${user} ...`);
+    const results = {};
+
+    results.pagesCreated = changes.filter(c => c.type === 'new');
+    results.pagesChanged = changes.filter(c => c.type === 'edit');
+    results.charsAdded = changes
+      .map(c => { return (c.oldlen < c.newlen) ? (c.newlen - c.oldlen) : 0; })
+      .reduce((a, b) => a + b);
+
+    // robot.logger.debug(`Created ${results.pagesCreated.length} pages`);
+    // robot.logger.debug(`Edited ${results.pagesChanged.length} pages`);
+    // robot.logger.debug(`Added ${results.charsAdded} lines of text\n`);
+    return results;
+  }
+
+  async function createContributions (changes) {
+    let promises = [];
+
+    for (const user of Object.keys(changes)) {
+      await createContributionForUserChanges(user, changes[user]);
+      await sleep(60000);
+    }
+
+    return Promise.resolve();
+  }
+
+  function pageTitlesFromChanges(changes) {
+    return [...new Set(changes.map(c => `"${c.title}"`))].join(', ');
+  }
+
+  function calculateAmountForChanges(details) {
+    let amount;
+
+    if (details.charsAdded < 500) {
+      amount = 500;
+    } else if (details.charsAdded < 2000) {
+      amount = 1500;
+    } else {
+      amount = 5000;
+    }
+
+    return amount;
+  }
+
+  function createContributionForUserChanges (user, changes) {
+    const dateNow = new Date();
+    const dateYesterday = dateNow.setDate(dateNow.getDate() - 1);
+    const date = (new Date(dateYesterday)).toISOString().split('T')[0];
+
+    const details = analyzeUserChanges(user, changes);
+    const amount = calculateAmountForChanges(details);
+
+    let desc = `Added ${details.charsAdded} characters of text.`;
+    if (details.pagesChanged.length > 0) {
+      desc = `Edited ${pageTitlesFromChanges(details.pagesChanged)}. ${desc}`;
+    }
+    if (details.pagesCreated.length > 0) {
+      desc = `Created ${pageTitlesFromChanges(details.pagesCreated)}. ${desc}`;
+    }
+    desc = `Wiki contributions: ${desc}`;
+
+    let url;
+    if (changes.length > 1) {
+      url = `${wikiURL}Special:Contributions/${user}?hideMinor=1`;
+    } else {
+      rc = changes[0];
+      url = `${wikiURL}index.php?title=${rc.title}&diff=${rc.revid}&oldid=${rc.old_revid}`;
+    }
+
+    return createContribution(user, date, amount, desc, url, details);
+  }
+
+  function updateTimestampForNextFetch () {
+    robot.logger.debug(`[hubot-kredits] Set timestamp for wiki changes fetch`);
+    robot.brain.set('kredits:mediawiki:last_processed_at', new Date().toISOString());
+  }
+
+  function processWikiChangesSinceLastRun () {
+    fetchChanges()
+      .then(res => groupChangesByUser(res))
+      .then(res => createContributions(res))
+      .then(() => updateTimestampForNextFetch());
+  }
+
+  cron.schedule('0 7 * * *', processWikiChangesSinceLastRun);
+
+};

integrations/utils/amount-from-labels.js

@@ -0,0 +1,21 @@
+module.exports = function (labels) {
+  const kreditsLabel = labels.filter(n => n.match(/^kredits/))[0];
+  // No label, no kredits
+  if (typeof kreditsLabel === 'undefined') { return 0; }
+
+  // TODO move amounts to config?
+  let amount;
+  switch(kreditsLabel) {
+    case 'kredits-1':
+      amount = 500;
+      break;
+    case 'kredits-2':
+      amount = 1500;
+      break;
+    case 'kredits-3':
+      amount = 5000;
+      break;
+  }
+
+  return amount;
+};

integrations/utils/kind-from-labels.js

@@ -0,0 +1,18 @@
+module.exports = function (labels) {
+  let kind = 'dev';
+
+  if (labels.find(l => l.match(/ops|operations/)))  {
+    kind = 'ops';
+  }
+  else if (labels.find(l => l.match(/docs|documentation/)))  {
+    kind = 'docs';
+  }
+  else if (labels.find(l => l.match(/design/)))  {
+    kind = 'design';
+  }
+  else if (labels.find(l => l.match(/community/)))  {
+    kind = 'community';
+  }
+
+  return kind;
+};

package.json

@@ -1,31 +1,36 @@
 {
   "name": "hubot-kredits",
-  "version": "1.6.0",
+  "version": "3.4.1",
   "description": "Kosmos Kredits functionality for chat bots",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "bin": {
-    "kredits-wallet-create": "scripts/create-wallet.js"
+    "create-wallet": "scripts/create-wallet.js"
   },
   "dependencies": {
-    "ethereumjs-wallet": "mvayngrib/ethereumjs-wallet",
-    "ipfs-api": "^14.0.3",
+    "cors": "^2.8.5",
+    "eth-provider": "^0.2.2",
+    "ethers": "^4.0.27",
+    "express": "^4.17.1",
+    "express-session": "^1.16.2",
+    "grant-express": "^4.6.1",
+    "group-array": "^1.0.0",
     "kosmos-schemas": "^1.1.2",
-    "kredits-contracts": "2.0.0",
-    "node-fetch": "^1.6.3",
-    "prompt": "^1.0.0",
-    "tv4": "^1.3.0",
-    "web3": "^0.18.4",
-    "web3-provider-engine": "^12.0.3"
+    "kredits-contracts": "^5.4.0",
+    "node-cron": "^2.0.3",
+    "node-fetch": "^2.3.0",
+    "prompt": "^1.0.0"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/67P/hubot-kredits.git"
   },
   "keywords": [
-    "kosmos"
+    "kosmos",
+    "kredits",
+    "hubot-scripts"
   ],
   "author": "Kosmos Developers <mail@kosmos.org>",
   "contributors": [

scripts/create-wallet.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 const fs = require('fs');
-const Wallet = require('ethereumjs-wallet');
+const ethers = require('ethers');
 const userPrompt = require('prompt');
 
 let schema = {
@@ -24,10 +24,10 @@ userPrompt.start();
 userPrompt.get(schema, (err, result) => {
   if (err) { throw(err); }
 
-  let wallet = Wallet.generate();
-  let content = JSON.stringify(wallet.toV3(result.password));
+  let wallet = ethers.Wallet.createRandom();
+  wallet.encrypt(result.password).then((walletJSON) => {
+    fs.writeFileSync(result.path, walletJSON);
+    console.log(`\nWrote encrypted wallet config to ${result.path}`);
+  });
 
-  fs.writeFileSync(result.path, content);
-
-  console.log(`\nWrote encrypted wallet config to ${result.path}`);
 });