3.0.0

Create contributions instead of proposals

README.md

@@ -5,7 +5,7 @@
 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 proposals for issuing kredits for project
+Internet and automatically create ERC721 tokens for issuing kredits for project
 contributions.
 
 ## Setup
@@ -33,7 +33,7 @@ As usual in Hubot, you can add all config as environment variables.
 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 proposals for all of them.
+issue contribution tokens for all of them.
 
 #### Setup
 
@@ -50,7 +50,7 @@ Point a GitHub organization webhook to the following URL:
 ### MediaWiki
 
 The MediaWiki integration will periodically check for wiki page creations and
-edits. It will create kredits proposals based on amount of text added.
+edits. It will create kredits contribution tokens based on amount of text added.
 
 #### Setup
 

index.js

@@ -6,7 +6,7 @@ const Kredits = require('kredits-contracts');
 
 const walletPath  = process.env.KREDITS_WALLET_PATH || './wallet.json';
 const walletJson  = fs.readFileSync(walletPath);
-const providerUrl = process.env.KREDITS_PROVIDER_URL || 'http://localhost:7545';
+const providerUrl = process.env.KREDITS_PROVIDER_URL;
 const networkId = parseInt(process.env.KREDITS_NETWORK_ID || 100);
 
 const ipfsConfig = {
@@ -27,9 +27,9 @@ module.exports = async function(robot) {
 
   let wallet;
   try {
-    wallet = await ethers.Wallet.fromEncryptedWallet(walletJson, process.env.KREDITS_WALLET_PASSWORD);
+    wallet = await ethers.Wallet.fromEncryptedJson(walletJson, process.env.KREDITS_WALLET_PASSWORD);
   } catch(error) {
-    robot.logger.warn('[hubot-kredits] Could not load wallet:', error);
+    robot.logger.warning('[hubot-kredits] Could not load wallet:', error);
     process.exit(1);
   }
 
@@ -37,9 +37,13 @@ module.exports = async function(robot) {
   // Ethereum provider/node setup
   //
 
-  const ethProvider = new ethers.providers.JsonRpcProvider(providerUrl, {chainId: networkId});
-  ethProvider.signer = wallet;
-  wallet.provider = ethProvider;
+  let ethProvider;
+  if (providerUrl) {
+    ethProvider = new ethers.providers.JsonRpcProvider(providerUrl);
+  } else {
+    ethProvider = new ethers.getDefaultProvider('rinkeby');
+  }
+  const signer = wallet.connect(ethProvider);
 
   //
   // Kredits contracts setup
@@ -47,13 +51,18 @@ module.exports = async function(robot) {
 
   let kredits;
   try {
-    kredits = await Kredits.setup(ethProvider, wallet, ipfsConfig);
+    kredits = await new Kredits(signer.provider, signer, {
+      // TODO support local devchain custom address
+      apm: 'open.aragonpm.eth',
+      ipfsConfig
+    }).init();
   } catch(error) {
-    robot.logger.warn('[hubot-kredits] Could not set up kredits:', error);
+    robot.logger.warning('[hubot-kredits] Could not set up kredits:', error);
     process.exit(1);
   }
   const Contributor = kredits.Contributor;
-  const Operator = kredits.Operator;
+  const Proposal = kredits.Proposal;
+  const Contribution = kredits.Contribution;
 
   robot.logger.info('[hubot-kredits] Wallet address: ' + wallet.address);
 
@@ -74,7 +83,7 @@ module.exports = async function(robot) {
 
   robot.respond(/got ETH\??/i, res => {
     ethProvider.getBalance(wallet.address).then((balance) => {
-      res.send(`my wallet contains ${ethers.utils.formatEther(balance)} ETH`);
+      res.send(`My wallet contains ${ethers.utils.formatEther(balance)} ETH`);
     });
   });
 
@@ -87,7 +96,7 @@ module.exports = async function(robot) {
   });
 
   robot.respond(/list open proposals/i, res => {
-    Operator.all().then((proposals) => {
+    Proposal.all().then((proposals) => {
       proposals.forEach((proposal) => {
         if (!proposal.executed) {
           Contributor.getById(proposal.contributorId).then((contributor) => {
@@ -111,19 +120,28 @@ module.exports = async function(robot) {
       robot.logger.debug(`[hubot-kredits] Watching events from block ${nextBlock} onward`);
       ethProvider.resetEventsBlock(nextBlock);
 
-      Operator.on('ProposalCreated', handleProposalCreated);
+      Proposal.on('ProposalCreated', handleProposalCreated);
+      Contribution.on('ContributionAdded', handleContributionAdded);
     });
   }
 
   function handleProposalCreated(proposalId, creatorAccount, contributorId, amount) {
     Contributor.getById(contributorId).then((contributor) => {
-      Operator.getById(proposalId).then((proposal) => {
+      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`);
       });
     });
   }
 
+  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/github.js

@@ -1,6 +1,10 @@
 const util = require('util');
 const fetch = require('node-fetch');
 
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
 module.exports = async function(robot, kredits) {
 
   function messageRoom(message) {
@@ -16,7 +20,7 @@ module.exports = async function(robot, kredits) {
   }
 
   const Contributor = kredits.Contributor;
-  const Operator = kredits.Operator;
+  const Contribution = kredits.Contribution;
 
   function getContributorByGithubUser(username) {
     return Contributor.all().then(contributors => {
@@ -31,9 +35,9 @@ module.exports = async function(robot, kredits) {
     });
   }
 
-  function createProposal(githubUser, amount, description, url, details) {
+  function createContribution(githubUser, amount, description, url, details) {
     return getContributorByGithubUser(githubUser).then(contributor => {
-      robot.logger.debug(`[hubot-kredits] Creating proposal to issue ${amount}₭S to ${githubUser} for ${url}...`);
+      robot.logger.debug(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${githubUser} for ${url}...`);
 
       let contributionAttr = {
         contributorId: contributor.id,
@@ -45,9 +49,10 @@ module.exports = async function(robot, kredits) {
         kind: 'dev'
       };
 
-      return Operator.addProposal(contributionAttr).catch(error => {
+      return Contribution.addContribution(contributionAttr).catch(error => {
         robot.logger.error(`[hubot-kredits] Error:`, error);
-        messageRoom(`I wanted to propose giving kredits to GitHub user ${githubUser} for ${url}, but I cannot find their info. Please add them as a contributor: https://kredits.kosmos.org`);
+        messageRoom(`I tried to add a contribution for ${githubUser} for ${url}, but I encountered an error when submitting the tx:`);
+        messageRoom(error.message);
       });
     });
   }
@@ -75,7 +80,7 @@ module.exports = async function(robot, kredits) {
     return amount;
   }
 
-  function handleGitHubIssueClosed(data) {
+  async function handleGitHubIssueClosed(data) {
     let recipients;
     let issue        = data.issue;
     let assignees    = issue.assignees.map(a => a.login);
@@ -86,7 +91,7 @@ module.exports = async function(robot, kredits) {
     let description = `${repoName}: ${issue.title}`;
 
     if (amount === 0) {
-      robot.logger.info('[hubot-kredits] Proposal amount from issue label is zero; ignoring');
+      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`);
@@ -99,15 +104,15 @@ module.exports = async function(robot, kredits) {
       recipients = [issue.user.login];
     }
 
-    let proposalPromises = [];
-    recipients.forEach(recipient => {
-      proposalPromises.push(
-        createProposal(recipient, amount, description, web_url, issue)
-          .catch(err => robot.logger.error(err))
-      );
-    });
+    for (const recipient of recipients) {
+      try {
+        await createContribution(recipient, amount, description, web_url, issue);
+        await sleep(60000);
+      }
+      catch (err) { robot.logger.error(err); }
+    }
 
-    return Promise.all(proposalPromises);
+    return Promise.resolve();
   }
 
   function handleGitHubPullRequestClosed(data) {
@@ -130,29 +135,28 @@ module.exports = async function(robot, kredits) {
         }
         return response.json();
       })
-      .then(issue => {
+      .then(async (issue) => {
         let amount = amountFromIssueLabels(issue);
         let repoName = pull_request.base.repo.full_name;
         let description = `${repoName}: ${pull_request.title}`;
 
         if (amount === 0) {
-          robot.logger.info('[hubot-kredits] Proposal amount from issue label is zero; ignoring');
+          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 proposalPromises = [];
-        recipients.forEach(recipient => {
-          console.debug(`[hubot-kredits] Creating proposal for ${recipient}...`);
-          proposalPromises.push(
-            createProposal(recipient, amount, description, web_url, pull_request)
-              .catch(err => robot.logger.error(err))
-          );
-        });
+        for (const recipient of recipients) {
+          try {
+            await createContribution(recipient, amount, description, web_url, pull_request);
+            await sleep(60000);
+          }
+          catch (err) { robot.logger.error(err); }
+        }
 
-        return Promise.all(proposalPromises);
+        return Promise.resolve();
       });
   }
 
@@ -166,10 +170,12 @@ module.exports = async function(robot, kredits) {
     robot.logger.info(`Received GitHub hook. Event: ${evt}, action: ${data.action}`);
 
     if (evt === 'pull_request' && data.action === 'closed') {
-      handleGitHubPullRequestClosed(data).then(() => res.send(200));
+      handleGitHubPullRequestClosed(data);
+      res.send(200);
     }
     else if (evt === 'issues' && data.action === 'closed') {
-      handleGitHubIssueClosed(data).then(() => res.send(200));
+      handleGitHubIssueClosed(data);
+      res.send(200);
     } else {
       res.send(200);
     }

integrations/mediawiki.js

@@ -1,8 +1,13 @@
+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) {
@@ -12,29 +17,25 @@ module.exports = async function(robot, kredits) {
   robot.logger.debug('[hubot-kredits] Loading MediaWiki integration...')
 
   const Contributor = kredits.Contributor;
-  const Operator = kredits.Operator;
+  const Contribution = kredits.Contribution;
 
-  const apiURL =  process.env.KREDITS_MEDIAWIKI_URL + 'api.php';
+  const wikiURL = process.env.KREDITS_MEDIAWIKI_URL;
+  const apiURL =  wikiURL + 'api.php';
 
   function getContributorByWikiUser(username) {
-    return Contributor.all().then(contributors => {
-      let contrib = contributors.find(c => {
-        if (typeof c.accounts !== 'object') { return false; }
-        return c.accounts.find(a => {
-          a.url === `${process.env.KREDITS_MEDIAWIKI_URL}User:${username}`;
-        });
-      });
-      if (!contrib) {
-        throw new Error();
-      } else {
-        return contrib;
-      }
+    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 createProposal(username, amount, description, url, details={}) {
+  function createContribution(username, amount, description, url, details={}) {
     return getContributorByWikiUser(username).then(contributor => {
-      robot.logger.debug(`[hubot-kredits] Creating proposal to issue ${amount}₭S to ${contributor.name} for ${url}...`);
+      robot.logger.debug(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${contributor.name} for ${url}...`);
 
       let contribution = {
         contributorId: contributor.id,
@@ -46,8 +47,8 @@ module.exports = async function(robot, kredits) {
         kind: 'docs'
       };
 
-      return Operator.addProposal(contribution).catch(error => {
-        robot.logger.error(`[hubot-kredits] Adding proposal failed:`, error);
+      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}`);
@@ -109,18 +110,19 @@ module.exports = async function(robot, kredits) {
     return results;
   }
 
-  function createProposals (changes) {
+  async function createContributions (changes) {
     let promises = [];
 
-    Object.keys(changes).forEach(user => {
-      promises.push(createProposalForUserChanges(user, changes[user]));
-    });
+    for (const user of Object.keys(changes)) {
+      await createContributionForUserChanges(user, changes[user]);
+      await sleep(60000);
+    }
 
-    return Promise.all(promises);
+    return Promise.resolve();
   }
 
   function pageTitlesFromChanges(changes) {
-    return changes.map(c => `"${c.title}"`).join(', ');
+    return [...new Set(changes.map(c => `"${c.title}"`))].join(', ');
   }
 
   function calculateAmountForChanges(details) {
@@ -138,9 +140,9 @@ module.exports = async function(robot, kredits) {
     return amount;
   }
 
-  function createProposalForUserChanges (user, changes) {
+  function createContributionForUserChanges (user, changes) {
     const details = analyzeUserChanges(user, changes);
-    const amount = calculateAmountForChanges(changes);
+    const amount = calculateAmountForChanges(details);
 
     let desc = `Added ${details.charsAdded} characters of text.`;
     if (details.pagesChanged.length > 0) {
@@ -149,16 +151,17 @@ module.exports = async function(robot, kredits) {
     if (details.pagesCreated.length > 0) {
       desc = `Created ${pageTitlesFromChanges(details.pagesCreated)}. ${desc}`;
     }
+    desc = `Wiki contributions: ${desc}`;
 
     let url;
     if (changes.length > 1) {
-      url = `https://wiki.kosmos.org/Special:Contributions/${user}?hideMinor=1`;
+      url = `${wikiURL}Special:Contributions/${user}?hideMinor=1`;
     } else {
       rc = changes[0];
-      url = `https://wiki.kosmos.org/index.php?title=${rc.title}&diff=${rc.revid}&oldid=${rc.old_revid}`;
+      url = `${wikiURL}index.php?title=${rc.title}&diff=${rc.revid}&oldid=${rc.old_revid}`;
     }
 
-    return createProposal(user, amount, desc, url, details);
+    return createContribution(user, amount, desc, url, details);
   }
 
   function updateTimestampForNextFetch () {
@@ -169,10 +172,10 @@ module.exports = async function(robot, kredits) {
   function processWikiChangesSinceLastRun () {
     fetchChanges()
       .then(res => groupChangesByUser(res))
-      .then(res => createProposals(res))
+      .then(res => createContributions(res))
       .then(() => updateTimestampForNextFetch());
   }
 
-  cron.schedule('* 7 * * *', processWikiChangesSinceLastRun);
+  cron.schedule('0 7 * * *', processWikiChangesSinceLastRun);
 
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot-kredits",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Kosmos Kredits functionality for chat bots",
   "main": "index.js",
   "scripts": {
@@ -10,13 +10,14 @@
     "create-wallet": "scripts/create-wallet.js"
   },
   "dependencies": {
-    "ethers": "^3.0.15",
+    "eth-provider": "^0.2.2",
+    "ethers": "^4.0.27",
     "group-array": "^0.3.3",
     "kosmos-schemas": "^1.1.2",
-    "node-cron": "^1.2.1",
-    "node-fetch": "^1.6.3",
-    "prompt": "^1.0.0",
-    "kredits-contracts": "3.x"
+    "kredits-contracts": "4.x",
+    "node-cron": "^2.0.3",
+    "node-fetch": "^2.3.0",
+    "prompt": "^1.0.0"
   },
   "repository": {
     "type": "git",