Update seeds

* Add build status badge
* Add section about testing
* Formatting

README.md

@@ -1,4 +1,5 @@
-[![npm](https://img.shields.io/npm/v/kredits-contracts.svg)](https://www.npmjs.com/package/kredits-contracts)
+[![npm](https://img.shields.io/npm/v/@kredits/contracts.svg)](https://www.npmjs.com/package/@kredits/contracts)
+[![Build Status](https://drone.kosmos.org/api/badges/kredits/contracts/status.svg)](https://drone.kosmos.org/kredits/contracts)
 
 # Kredits Contracts
 
@@ -26,27 +27,27 @@ To run a local development chain run:
 
 ### Bootstrap
 
-1.  Run an Ethereum node and ipfs
+1. Run an EVM node and ipfs
 
         $ npm run devchain
         $ ipfs daemon
 
-2.  Compile contracts and build ABIs
+2. Compile contracts and build ABIs
 
         (compiled artifacts will be in `/artifacts`)
         $ npm run build
 
-3.  Deploy new upgradable contract proxies
+3. Deploy new upgradable contract proxies
 
         $ npm run deploy:dao
 
-4.  Execute seeds to create demo contributors, contributions, etc. (optional)
+4. Execute seeds to create demo contributors, contributions, etc. (optional)
 
         $ npm run seeds
 
 **Step 2-4 is also summarized in `npm run bootstrap`**
 
-5.  Show contract addresses
+5. Show contract addresses
 
         $ cat lib/addresses.json
 
@@ -56,6 +57,16 @@ If you need to fund development accounts with devchain coins:
 
     $ npm run fund # or hardhat fund --network localhost
 
+## Specs / Testing
+
+With a local development chain running:
+
+    $ hardhat test
+
+If you add or change contract code, please make sure to add and/or adapt tests
+accordingly. Don't worry, it's easy! You can use existing tests as a template
+for new ones.
+
 ## Contract architecture
 
 We use the [OpenZeppelin hardhat
@@ -145,12 +156,3 @@ To run the console on one of the non localhost networks you can also just pass
 on the --network argument.
 
     $ hardhat console --network rsk
-
-
-## Known Issues
-
-When resetting ganache Metamask might have an invalid transaction nonce and
-transactions get rejected. Nonces in Ethereum must be incrementing and have no
-gap.
-
-To solve this reset the metamask account (Account -> Settings -> Reset Account)

config/seeds.js

@@ -15,7 +15,7 @@ const contractCalls = [
     name: 'raucao',
     kind: 'person',
     url: '',
-    github_username: 'skddc',
+    github_username: 'raucao',
     github_uid: 842,
     gitea_username: 'raucao',
     wiki_username: 'Basti',

contracts/Reimbursement.sol

@@ -16,6 +16,7 @@ contract Reimbursement is Initializable {
   struct ReimbursementData {
     uint32 recipientId;
     uint256 amount;
+    // TODO remove token entirely
     address token;
     bytes32 hashDigest;
     uint8 hashFunction;

lib/addresses.json

@@ -1,4 +1,10 @@
 {
+  "31": {
+    "Contributor": "0xf1073Dab6e305583F95e451Cba449bB867a6e3Fd",
+    "Contribution": "0x1C531F824e339cD37D75B7F391cB8E42e0E0d4bd",
+    "Token": "0x56F64C3BB45e6a248F4C783f5a1633E53D6A2371",
+    "Reimbursement": "0x9C5fFBFba2570A9b31D60338453C5480Ce74B342"
+  },
   "1337": {
     "Contributor": "0xCc66f9A3cA2670972938FAD91d0865c4a62DFB25",
     "Contribution": "0x8999CaBc43E28202c5A2257f2a95A45b1F8A62BD",

lib/kredits.js

@@ -69,7 +69,10 @@ class Kredits {
     if (wallet) {
       signer = wallet.connect(ethProvider);
     } else if (ethProvider.getSigner) {
-      signer = ethProvider.getSigner();
+      // Only useful for reading data, not writing. The (unused) address is
+      // necessary because without an address, ethers.js will try to look up
+      // the provider's account 0, which doesn't work on our public RSK nodes.
+      signer = ethProvider.getSigner('0xfa77675540E550b911a6AABF3805ac17C6641ec1');
     }
     return new Kredits(ethProvider, signer, kreditsOptions);
   }

package-lock.json

@@ -1,12 +1,12 @@
 {
-  "name": "kredits-contracts",
-  "version": "7.0.0-beta.0",
+  "name": "@kredits/contracts",
+  "version": "7.0.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
-      "name": "kredits-contracts",
-      "version": "7.0.0-beta.0",
+      "name": "@kredits/contracts",
+      "version": "7.0.1",
       "license": "MIT",
       "dependencies": {
         "@kosmos/schemas": "^3.1.0",

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "kredits-contracts",
-  "version": "7.0.0-beta.0",
-  "description": "Ethereum contracts and npm wrapper for Kredits",
+  "name": "@kredits/contracts",
+  "version": "7.0.1",
+  "description": "Smart contracts and JavaScript API for Kredits",
   "main": "./lib/kredits.js",
   "directories": {
     "test": "test"

scripts/import/contributions.js

@@ -6,6 +6,8 @@ async function main() {
   await kredits.init();
 
   console.log(`Using Contribution at: ${kredits.Contribution.contract.address}`);
+  const count = await kredits.Contribution.count;
+  console.log(`Currently ${count} entries`);
 
   try {
     const data = fs.readFileSync("./data/contributions.json");
@@ -28,11 +30,11 @@ async function main() {
         c.hashDigest, c.hashFunction, c.hashSize,
         confirmedAtBlock, c.vetoed
       );
-      // await result.wait();
-      console.log(`Added contribution #${contributionId}: ${result.hash}`);
+      console.log(`Adding contribution #${contributionId}: ${result.hash}`);
+      await result.wait();
     };
   } catch(e) {
-    console.log(e);
+    console.error(e);
   }
 }
 

scripts/import/contributors.js

@@ -6,7 +6,8 @@ async function main() {
   await kredits.init();
 
   console.log(`Using Contributor at: ${kredits.Contributor.contract.address}`);
-
+  const count = await kredits.Contributor.count;
+  console.log(`Currently ${count} entries`);
   try {
     const data = fs.readFileSync("./data/contributors.json");
     const contributors = JSON.parse(data);
@@ -22,11 +23,11 @@ async function main() {
         contributor.hashFunction,
         contributor.hashSize,
       );
-      // await result.wait();
-      console.log(`Added contributor #${contributorId}: ${result.hash}`);
+      console.log(`Adding contributor #${contributorId}: ${result.hash}`);
+      await result.wait();
     };
   } catch(e) {
-    console.log(e);
+    console.error(e);
   }
 }
 

scripts/list-contributors.js

@@ -6,6 +6,8 @@ async function main() {
   await kredits.init();
 
   console.log(`Using Contributor at: ${kredits.Contributor.contract.address}`);
+  const count = await kredits.Contributors.count;
+  console.log(`Currently ${count} entries`);
 
   const table = new Table({
     head: ['ID', 'Account', 'Name', 'Core?', 'Balance', 'Kredits earned', 'Contributions count', 'IPFS']