5.3.0

Add kredits-formatter and additionally format balance

apps/contribution/contracts/Contribution.sol

@@ -118,6 +118,26 @@ contract Contribution is AragonApp {
   // Custom functions
   //
 
+  function totalKreditsEarned(bool confirmedOnly) public view returns (uint256 count) {
+    for (uint32 i = 1; i <= contributionsCount; i++) {
+      ContributionData memory c = contributions[i];
+      if (block.number >= c.confirmedAtBlock || !confirmedOnly) {
+        count += c.amount; // should use safemath
+      }
+    }
+  }
+
+  function totalKreditsEarnedByContributor(uint32 contributorId, bool confirmedOnly) public view returns (uint256 count) {
+    uint256 tokenBalance = ownedContributions[contributorId].length;
+    for (uint256 i = 0; i < tokenBalance; i++) {
+      uint32 cId = ownedContributions[contributorId][i];
+      ContributionData memory c = contributions[cId];
+      if (block.number >= c.confirmedAtBlock || !confirmedOnly) {
+        count += c.amount; // should use safemath
+      }
+    }
+  }
+
   function getContribution(uint32 contributionId) public view returns (uint32 id, uint32 contributorId, uint32 amount, bool claimed, bytes32 hashDigest, uint8 hashFunction, uint8 hashSize, uint256 confirmedAtBlock, bool exists, bool vetoed) {
     id = contributionId;
     ContributionData storage c = contributions[id];

apps/contributor/contracts/Contributor.sol

@@ -6,6 +6,10 @@ import "@aragon/os/contracts/kernel/IKernel.sol";
 interface ITokenBalance {
   function balanceOf(address contributorAccount) public view returns (uint256);
 }
+interface IContributionBalance {
+  function totalKreditsEarnedByContributor(uint32 contributorId, bool confirmedOnly) public view returns (uint256 count);
+  function balanceOf(address owner) public view returns (uint256);
+}
 
 contract Contributor is AragonApp {
   bytes32 public constant KERNEL_APP_ADDR_NAMESPACE = 0xd6f028ca0e8edb4a8c9757ca4fdccab25fa1e0317da1188108f7d2dee14902fb;
@@ -43,6 +47,12 @@ contract Contributor is AragonApp {
     return k.getApp(KERNEL_APP_ADDR_NAMESPACE, appIds[uint8(Apps.Token)]);
   }
 
+  function getContributionContract() public view returns (address) {
+    IKernel k = IKernel(kernel());
+
+    return k.getApp(KERNEL_APP_ADDR_NAMESPACE, appIds[uint8(Apps.Contribution)]);
+  }
+
   function coreContributorsCount() view public returns (uint32) {
     uint32 count = 0;
     for (uint32 i = 1; i <= contributorsCount; i++) {
@@ -118,7 +128,7 @@ contract Contributor is AragonApp {
     return contributors[id];
   }
 
-  function getContributorById(uint32 _id) public view returns (uint32 id, address account, bytes32 hashDigest, uint8 hashFunction, uint8 hashSize, bool isCore, uint256 balance, bool exists ) {
+  function getContributorById(uint32 _id) public view returns (uint32 id, address account, bytes32 hashDigest, uint8 hashFunction, uint8 hashSize, bool isCore, uint256 balance, uint256 totalKreditsEarned, uint256 contributionsCount, bool exists ) {
     id = _id;
     Contributor storage c = contributors[_id];
     account = c.account;
@@ -128,6 +138,9 @@ contract Contributor is AragonApp {
     isCore = isCoreTeam(id);
     address token = getTokenContract();
     balance = ITokenBalance(token).balanceOf(c.account);
+    address contribution = getContributionContract();
+    totalKreditsEarned = IContributionBalance(contribution).totalKreditsEarnedByContributor(_id, true);
+    contributionsCount = IContributionBalance(contribution).balanceOf(c.account);
     exists = c.exists;
   }
 

config/seeds.js

@@ -1,7 +1,36 @@
 const contractCalls = [
-  ['Contributor', 'add', [{ account: '0x7e8f313c56f809188313aa274fa67ee58c31515d', name: 'bumi', kind: 'person', url: '', github_username: 'bumi', github_uid: 318, wiki_username: 'Bumi' }, { gasLimit: 200000 }]],
+  ['Contributor', 'add', [{
-  ['Contributor', 'add', [{ account: '0x49575f3DD9a0d60aE661BC992f72D837A77f05Bc', name: 'raucao', kind: 'person', url: '', github_username: 'skddc', github_uid: 842, wiki_username: 'Basti' }, { gasLimit: 200000 }]],
+    account: '0x7e8f313c56f809188313aa274fa67ee58c31515d',
-  ['Contributor', 'add', [{ account: '0xF722709ECC3B05c19d02E82a2a4A4021B8F48C62', name: 'Manuel', kind: 'person', url: '', github_username: 'fsmanuel', github_uid: 54812, wiki_username: 'Manuel' }, { gasLimit: 200000 }]],
+    name: 'bumi',
+    kind: 'person',
+    url: '',
+    github_username: 'bumi',
+    github_uid: 318,
+    gitea_username: 'bumi',
+    wiki_username: 'Bumi'
+  }, { gasLimit: 200000 }]],
+
+  ['Contributor', 'add', [{
+    account: '0x49575f3DD9a0d60aE661BC992f72D837A77f05Bc',
+    name: 'raucao',
+    kind: 'person',
+    url: '',
+    github_username: 'skddc',
+    github_uid: 842,
+    gitea_username: 'raucao',
+    wiki_username: 'Basti'
+  }, { gasLimit: 200000 }]],
+
+  ['Contributor', 'add', [{
+    account: '0xF722709ECC3B05c19d02E82a2a4A4021B8F48C62',
+    name: 'Manuel',
+    kind: 'person',
+    url: '',
+    github_username: 'fsmanuel',
+    github_uid: 54812,
+    wiki_username: 'Manuel'
+  }, { gasLimit: 200000 }]],
+
   ['Proposal', 'addProposal', [{ contributorId: 1, contributorIpfsHash: 'QmWKCYGr2rSf6abUPaTYqf98urvoZxGrb7dbspFZA6oyVF', date: '2019-04-09', amount: 500, kind: 'dev', description: '[67P/kredits-contracts] Ran the seeds', url: '' }, { gasLimit: 350000 }]],
   ['Proposal', 'addProposal', [{ contributorId: 2, contributorIpfsHash: 'QmcHzEeAM26HV2zHTf5HnZrCtCtGdEccL5kUtDakAB7ozB', date: '2019-04-10', amount: 500, kind: 'dev', description: '[67P/kredits-contracts] Ran the seeds', url: '' }, { gasLimit: 350000 }]],
   ['Proposal', 'addProposal', [{ contributorId: 2, contributorIpfsHash: 'QmcHzEeAM26HV2zHTf5HnZrCtCtGdEccL5kUtDakAB7ozB', date: '2019-04-11', amount: 500, kind: 'dev', description: '[67P/kredits-contracts] Hacked on kredits', url: '' }, { gasLimit: 350000 }]],

lib/contracts/contribution.js

@@ -1,21 +1,9 @@
-const ethers = require('ethers');
+const Record = require('./record');
-
 const ContributionSerializer = require('../serializers/contribution');
-const Base = require('./base');
 
-class Contribution extends Base {
+class Contribution extends Record {
-  all() {
+  get count () {
-    return this.functions.contributionsCount()
+    return this.functions.contributionsCount();
-      .then(async (count) => {
-        let contributions = [];
-
-        for (let id = 1; id <= count; id++) {
-          const contribution = await this.getById(id)
-          contributions.push(contribution);
-        }
-
-        return contributions;
-      });
   }
 
   getById(id) {

lib/contracts/contributor.js

@@ -1,27 +1,18 @@
-const RSVP = require('rsvp');
+const Record = require('./record');
-
 const ContributorSerializer = require('../serializers/contributor');
-const Base = require('./base');
+const formatKredits = require('../utils/format-kredits');
 
-class Contributor extends Base {
+class Contributor extends Record {
-  all() {
+  get count () {
-    return this.functions.contributorsCount()
+    return this.functions.contributorsCount();
-      .then(count => {
-        let contributors = [];
-
-        for (let id = 1; id <= count; id++) {
-          contributors.push(this.getById(id));
-        }
-
-        return RSVP.all(contributors);
-      });
   }
 
   getById(id) {
     return this.functions.getContributorById(id)
-      .then((data) => {
+      .then(data => {
+        data.balanceInt = formatKredits(data.balance);
         return this.ipfs.catAndMerge(data, ContributorSerializer.deserialize);
-      });
+      })
   }
 
   filterByAccount(search) {
@@ -48,12 +39,16 @@ class Contributor extends Base {
     });
   }
 
-  add(contributorAttr, callOptions = {}) {
+  async add(contributorAttr, callOptions = {}) {
-    let json = ContributorSerializer.serialize(contributorAttr);
+    let contributor = new ContributorSerializer(contributorAttr);
-    // TODO: validate against schema
+
+    try { await contributor.validate(); }
+    catch (error) { return Promise.reject(error); }
+
+    const jsonStr = contributor.serialize();
 
     return this.ipfs
-      .add(json)
+      .add(jsonStr)
       .then((ipfsHashAttr) => {
         let contributor = [
           contributorAttr.account,
@@ -65,6 +60,30 @@ class Contributor extends Base {
         return this.functions.addContributor(...contributor, callOptions);
       });
   }
+
+  updateProfile(contributorId, updateAttr, callOptions = {}) {
+    return this.getById(contributorId).then(async (contributor) => {
+      let updatedContributorAttr = Object.assign(contributor, updateAttr)
+      let updatedContributor = new ContributorSerializer(updatedContributorAttr);
+
+      try { await updatedContributor.validate(); }
+      catch (error) { return Promise.reject(error); }
+
+      const jsonStr = updatedContributor.serialize();
+
+      return this.ipfs
+        .add(jsonStr)
+        .then(ipfsHashAttr => {
+          return this.functions.updateContributorProfileHash(
+            contributorId,
+            ipfsHashAttr.hashDigest,
+            ipfsHashAttr.hashFunction,
+            ipfsHashAttr.hashSize,
+            callOptions
+          );
+        });
+    });
+  }
 }
 
 module.exports = Contributor;

lib/contracts/proposal.js

@@ -1,20 +1,9 @@
-const RSVP = require('rsvp');
+const Record = require('./record');
-
 const ContributionSerializer = require('../serializers/contribution');
-const Base = require('./base');
 
-class Proposal extends Base {
+class Proposal extends Record {
-  all() {
+  get count () {
-    return this.functions.proposalsCount()
+    return this.functions.proposalsCount();
-      .then(count => {
-        let proposals = [];
-
-        for (let id = 1; id <= count; id++) {
-          proposals.push(this.getById(id));
-        }
-
-        return RSVP.all(proposals);
-      });
   }
 
   getById(id) {

lib/contracts/record.js

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

lib/kredits.js

@@ -1,5 +1,4 @@
 const ethers = require('ethers');
-const RSVP = require('rsvp');
 
 const Preflight = require('./utils/preflight');
 
@@ -57,7 +56,8 @@ class Kredits {
           );
         });
       });
-      return RSVP.all(addressPromises).then(() => { return this });
+
+      return Promise.all(addressPromises).then(() => { return this });
     });
   }
 

lib/serializers/contributor.js

@@ -1,3 +1,5 @@
+const schemas = require('kosmos-schemas');
+const validator = require('../utils/validator');
 /**
  * Handle serialization for JSON-LD object of the contributor, according to
  * https://github.com/67P/kosmos-schemas/blob/master/schemas/contributor.json
@@ -6,41 +8,9 @@
  * @public
  */
 class Contributor {
- /**
-  * Deserialize JSON to object
-  *
-  * @method
-  * @public
-  */
-  static deserialize(serialized) {
-    let {
-      name,
-      kind,
-      url,
-      accounts,
-    } = JSON.parse(serialized.toString('utf8'));
 
-    let github_username, github_uid, wiki_username;
+  constructor(attrs) {
-    let github = accounts.find((a) => a.site === 'github.com');
+    Object.keys(attrs).forEach(a => this[a] = attrs[a]);
-    let wiki   = accounts.find((a) => a.site === 'wiki.kosmos.org');
-
-    if (github) {
-      (({ username: github_username, uid: github_uid} = github));
-    }
-    if (wiki) {
-      (({ username: wiki_username } = wiki));
-    }
-
-    return {
-      name,
-      kind,
-      url,
-      accounts,
-      github_uid,
-      github_username,
-      wiki_username,
-      ipfsData: serialized,
-    };
   }
 
  /**
@@ -49,15 +19,16 @@ class Contributor {
   * @method
   * @public
   */
-  static serialize(deserialized) {
+  serialize () {
     let {
       name,
       kind,
       url,
       github_uid,
       github_username,
+      gitea_username,
       wiki_username,
-    } = deserialized;
+    } = this;
 
     let data = {
       "@context": "https://schema.kosmos.org",
@@ -80,6 +51,14 @@ class Contributor {
       });
     }
 
+    if (gitea_username) {
+      data.accounts.push({
+        "site": "gitea.kosmos.org",
+        "username": gitea_username,
+        "url": `https://gitea.kosmos.org/${gitea_username}`
+      });
+    }
+
     if (wiki_username) {
       data.accounts.push({
         "site": "wiki.kosmos.org",
@@ -91,6 +70,60 @@ class Contributor {
     // Write it pretty to ipfs
     return JSON.stringify(data, null, 2);
   }
+
+  /**
+   * Validate serialized data against schema
+   *
+   * @public
+   */
+  validate () {
+    const serialized = JSON.parse(this.serialize());
+    const valid = validator.validate(serialized, schemas['contributor']);
+    return valid ? Promise.resolve() : Promise.reject(validator.error);
+  }
+
+  /**
+  * Deserialize JSON to object
+  *
+  * @method
+  * @public
+  */
+  static deserialize (serialized) {
+    let {
+      name,
+      kind,
+      url,
+      accounts,
+    } = JSON.parse(serialized.toString('utf8'));
+
+    let github_username, github_uid, gitea_username, wiki_username;
+    let github = accounts.find(a => a.site === 'github.com');
+    let gitea  = accounts.find(a => a.site === 'gitea.kosmos.org');
+    let wiki   = accounts.find(a => a.site === 'wiki.kosmos.org');
+
+    if (github) {
+      (({ username: github_username, uid: github_uid} = github));
+    }
+    if (gitea) {
+      (({ username: gitea_username } = gitea));
+    }
+    if (wiki) {
+      (({ username: wiki_username } = wiki));
+    }
+
+    return {
+      name,
+      kind,
+      url,
+      accounts,
+      github_uid,
+      github_username,
+      gitea_username,
+      wiki_username,
+      ipfsData: serialized,
+    };
+  }
+
 }
 
 module.exports = Contributor;

lib/utils/format-kredits.js

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

lib/utils/pagination.js

@@ -0,0 +1,46 @@
+function pageNumber(number, size, recordCount) {
+  let numberOfPages = Math.ceil(recordCount / size);
+
+  number = parseInt(number) || 1;
+
+  // Ensure page number is in range
+  number = number < 1 ? 1 : number;
+  number = number > numberOfPages ? numberOfPages : number;
+
+  return number;
+}
+
+function buildIds(order, number, size, recordCount) {
+  let offset = size * (number - 1);
+
+  let start;
+  let mapFunction;
+
+  if (order === 'asc') {
+    start = 1 + offset;
+    mapFunction = (_, i) => start + i;
+  } else {
+    start = recordCount - offset;
+    mapFunction = (_, i) => start - i;
+  }
+
+  // Ensure size is in range
+  let end = offset + size;
+  if (end > recordCount) {
+    let diff = end - recordCount;
+    size = size - diff;
+  }
+
+  return Array.from({ length: size }, mapFunction);
+}
+
+module.exports = function paged(recordCount, options = {}) {
+  let { order, page } = options;
+  order = order || 'desc';
+  page = page || {};
+
+  let size = parseInt(page.size) || 25;
+  let number = pageNumber(page.number, size, recordCount);
+
+  return buildIds(order, number, size, recordCount);
+};

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "kredits-contracts",
-  "version": "5.1.1",
+  "version": "5.3.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kredits-contracts",
-  "version": "5.1.1",
+  "version": "5.3.0",
   "description": "Ethereum contracts and npm wrapper for Kredits",
   "main": "./lib/kredits.js",
   "directories": {
@@ -46,7 +46,6 @@
     "ethers": "^4.0.27",
     "ipfs-http-client": "^30.1.1",
     "kosmos-schemas": "^2.0.0",
-    "rsvp": "^4.8.2",
     "tv4": "^1.3.0"
   },
   "keywords": [

scripts/add-contributor.js

@@ -26,7 +26,7 @@ module.exports = async function(callback) {
     kind: await prompt('Kind (default person): ', {default: 'person'}),
     url: await prompt('URL: '),
     github_username: await prompt('GitHub username: '),
-    github_uid: await prompt('GitHub UID: '),
+    github_uid: parseInt(await prompt('GitHub UID: ')),
     wiki_username: await prompt('Wiki username: '),
   };
 

scripts/list-contributions.js

@@ -22,6 +22,7 @@ module.exports = async function(callback) {
     let blockNumber = await kredits.provider.getBlockNumber();
     let contributions = await kredits.Contribution.all();
 
+    console.log(`Current block number: ${blockNumber}`);
     contributions.forEach((c) => {
       const confirmed = c.confirmedAtBlock <= blockNumber;
 
@@ -30,7 +31,7 @@ module.exports = async function(callback) {
         c.contributorId,
         `${c.description}`,
         c.amount.toString(),
-        confirmed,
+        `${confirmed} (${c.confirmedAtBlock})`,
         c.vetoed,
         c.claimed,
         c.ipfsHash
@@ -38,6 +39,9 @@ module.exports = async function(callback) {
     });
 
     console.log(table.toString());
+
+    let totalKreditsEarned = await kredits.Contribution.functions.totalKreditsEarned(true);
+    console.log(`Total confirmed kredits: ${totalKreditsEarned}`);
   } catch (err) {
     console.log(err);
   }

scripts/list-contributors.js

@@ -15,24 +15,31 @@ module.exports = async function(callback) {
 
   console.log(`Using Contributor at: ${kredits.Contributor.contract.address}`);
 
-
   const table = new Table({
-    head: ['ID', 'Account', 'Name', 'Core?', 'Balance', 'IPFS']
+    head: ['ID', 'Account', 'Name', 'Core?', 'Balance', 'Kredits earned', 'Contributions count', 'IPFS']
   })
 
-  let contributors = await kredits.Contributor.all()
+  try {
+    const contributors = await kredits.Contributor.all()
+
+    contributors.forEach((c) => {
+      table.push([
+        c.id.toString(),
+        c.account,
+        `${c.name}`,
+        c.isCore,
+        c.balanceInt.toString(),
+        c.totalKreditsEarned.toString(),
+        c.contributionsCount.toString(),
+        c.ipfsHash
+      ])
+    })
+
+    console.log(table.toString())
+  } catch(e) {
+    callback(e);
+    return;
+  }
 
-  contributors.forEach((c) => {
-    table.push([
-      c.id.toString(),
-      c.account,
-      `${c.name}`,
-      c.isCore,
-      ethers.utils.formatEther(c.balance),
-      c.ipfsHash
-    ])
-  })
-  console.log(table.toString())
   callback()
 }
-