Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/naszam/ants-review

:1st_place_medal: @ETHTurin | KERNEL Genesis Block :seedling: Team @gitcoinco :ant:
https://github.com/naszam/ants-review

ants-review bounties erc-20 ethereum ipfs peer-reviews science

Last synced: 2 months ago
JSON representation

:1st_place_medal: @ETHTurin | KERNEL Genesis Block :seedling: Team @gitcoinco :ant:

Lists

README 

        
[![#ubuntu 18.04](https://img.shields.io/badge/ubuntu-v18.04-orange?style=plastic)](https://ubuntu.com/download/desktop)

[![#npm 12.16.3](https://img.shields.io/badge/npm-v12.16.3-blue?style=plastic)](https://github.com/nvm-sh/nvm#installation-and-update)

[![#built_with_Truffle](https://img.shields.io/badge/built%20with-Truffle-blueviolet?style=plastic)](https://www.trufflesuite.com/)

[![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF?style=plastic)](https://docs.openzeppelin.com/)

[![#solc v0.6.12](https://img.shields.io/badge/solc-v0.6.12-brown?style=plastic)](https://github.com/ethereum/solidity/releases/tag/v0.6.12)

[![#testnet kovan](https://img.shields.io/badge/testnet-Kovan-purple?style=plastic&logo=Ethereum)](#project-mvp-deployed-on-kovan)

[![#testnet rinkeby](https://img.shields.io/badge/testnet-Rinkeby-yellow?style=plastic&logo=Ethereum)](https://rinkeby.etherscan.io/address/0x6956dF88120c44fb446761947cD4B83b553F229F)



[![ETH Turin 2020](https://img.shields.io/badge/%CE%9E-ETH%20Turin%202020-F64060.svg)](https://ethlocal.co/ethturin/hacks)

[![DOI](https://zenodo.org/badge/258342275.svg)](https://zenodo.org/badge/latestdoi/258342275)  






# Ants-Review

> A Protocol for Open Anonymous Scientific Peer-Reviews on Ethereum  

> :1st_place_medal: 1st Place at [ETHTurin Hackathon](https://ethlocal.co/ethturin/hacks)



The Project implements a Bounty-like protocol called Ants-Review to allow issuers to issue an AntReview, a bounty for peer-review in scientific publication, linked to requirements stored on ipfs which peer-reviewers can fufill by submitting the ipfs hash which contains evidence of their fufillment.  

After the submission of successful peer-reviews, they will be approved by an approver and payed in ANTS.  



Project (MVP) feautures:

- ERC20 token, name: Ants-Review, symbol: ANTS.

- ANTS Faucet on Kovan.

- IPFS Hash Timestamped on Ethereum via PoE (Proof of Existence).

- Storing on IPFS.

- UI Deployed on IPFS via Fleek.



Future integrations & features:



- OpenGSN for Meta Transactions.

- zkANTS, allowing private ANTS transactions on Ethereum using ZK-SNARKs via AZTEC Protocol.

- De-Fi services like Dai, Chai, MakerDAO DSR, ...

- ENS, allowing human-readable Ethereum addresses

- Quadratic Funding Gitcoin-like for Ants-Review.

- Upgradability, to allow the logic to be extended and improved.

- ...



![Demo MVP](mvp.gif)



## Mentors

- Mark Beylin, [@mbeylin](https://github.com/mbeylin)

- Andy Tudhope, [@andytudhope](https://github.com/andytudhope)



[White Paper](https://zenodo.org/record/3828087#.Xr8XVXVKg5k)  

[Presentation](https://zenodo.org/record/3828067#.Xr8Pv3VKg5k)  

[Demo (PoC)](https://youtu.be/uMqksNytsMY)  

[Pich Deck](https://www.beautiful.ai/player/-MEwnYOfba26O3Zg0WX9)  

[FDAPP 2020](https://www.youtube.com/watch?v=x_1Pqh6a3U4&feature=youtu.be&t=12281)



## Sections

* [Building Blocks](#building-blocks)

* [Setup](#setup)

* [Deploy](#deploy)

* [Using the DApp](#using-the-dapp)

* [Front-end](#front-end)

* [Interacting with the PoC](#interacting-with-the-poc)

* [About](#about)



Building Blocks

===============



![Smart Contracts Flow-Chart](AntsReview.png)



### [AntsReview](./contracts/AntsReview.sol)

> AntsReview a bounty-like system for scientific peer-reviews rewarded in ANTS



AntReview implements a bounty for scientific peer-reviews called AntReview where there are several key types of users:



  - AntReview **Issuers** are addresses, added by the owner of the contract, that can issue an AntReview via the function *issueAntReview()*.

  - AntReview **Approvers** are addresses added by Issuers when they issue an AntReview or with the function *addApprover()*.

  - AntReview **Contributors** are any address which has made a contribution of ANTS to a given AntReview.

  - AntReview **Peer-Reviewers** are addresses, added by the owner of the contract, that can fulfill an AntReview via the function *fulfillAntReview()*.

  - AntReview **Submitters** are peer-reviers that submit a peer-review that can update their review via the function *updateReview()*.



There are several core actions in the lifecycle of an AntReview, which can be performed by certain users:



  - **issueAntReview()** called by any Issuers to issu an AntReview, specifying the paper and requirements IPFS hash as well as issuers, approver and the deadline.

  - **changeAntReview()** called by any *Issuers* specified in an AntReview that can update the details of the AntReview.

  - **addApprover()** called by any *issuers* specified in an AntReview that can add an Approver.

  - **removeApprover()** called by any *issuers* specified in an AntReview that can remove an Approver.

  - **contribute()** called by any address that can send some ANTS to the AntReview of interest.

  - **refund()** called by any *Contributors* that can get a refund once the deadline is elapsed with no peer-reviews accepted.

  - **fulfillAntReview()** called by any *Peer-Reviewer* that can fulfill an AntReview, specyfing the IPFS hash of the peer-review.

  - **updateAntReview()** called by any *Submitters* to update a specific Peer-Review, by specifying the new IPFS hash of the updated peer-review.

  - **acceptAntReview()** called by any *Approver* to accept a peer-review for a specific AntReview and paying an amount of ANTS as reward.

  - **withdrawReview()** called by any *issuers* specified in an AntReview that can withdraw an amount from the AntReview once the deadline is elapsed to get the residual balance.



### [AntsReviewRoles](./contracts/AntsReviewRoles.sol)

> AntsReviewRoles Access Management for Default Admin, Issuer, Peer-Reviewer and Pauser Role



AntsReviewRoles inherits AccessControl module by OpenZeppelin, allowing the owner of the contract to be set as Default Admin and Pauser and to add Issuers and Peer-Reviewers via **addIssuer()** and **addPeerReviewer()** and to remove these roles via **removeIssuer()**, **removePeerReviewer()** functions.



### [ANTS](./contracts/ANTS.sol)

> ANTS Ants-Review's native token



ANTS is the ERC20 token used by the Ants-Review Protocol.  

It allows the owner of the contract, set as Default Admin, Minter and Pauser to add and remove a Minter via **addMinter()**, **removeMinter()** functions.

The minter is able create new ANTS tokens via **mint()** and the holder to burn them via the **burn()** function.  



During deployment the contract sets the following ERC20 metadata:

- name: "Ants-Review"

- symbol: "ANTS"  



### [AntsFaucet](./contracts/AntsFaucet.sol)

> AntsFaucet ANTS Faucet



AntsFaucet implements an ANTS Faucet to be used on Kovan to test the Ants-Review Protocol.  

Anyone can get 10 ANTS by calling the **withdraw()** function.



Setup

=====



Clone this GitHub repository.



## Steps to compile and deploy



  - Local dependencies:

    - Truffle

    - Ganache CLI

    - OpenZeppelin Library v3.0

    - Truffle HD Wallet Provider

    - Truffle Flattener

    ```sh

    $ npm i

    ```

 - Global dependencies:

    - Truffle (recommended):

    ```

    npm install -g truffle

    ```

    - Ganache CLI (recommended):

    ```

    npm install -g ganache-cli

    ```

    - Slither (optional):

    ```sh

    $ git clone https://github.com/crytic/slither.git && cd slither

    $ sudo python3 setup.py install

    ```

    - MythX CLI (optional):

    ```sh

    $ git clone git://github.com/dmuhs/mythx-cli

    $ sudo python setup.py install

    ```

## Running the project with local test network (ganache-cli)



   - Start ganache-cli with the following command (global dependency):

     ```sh

     $ ganache-cli

     ```

   - Compile the smart contract using Truffle with the following command (global dependency):

     ```sh

     $ truffle compile

     ```

   - Deploy the smart contracts using Truffle & Ganache with the following command (global dependency):

     ```sh

     $ truffle migrate

     ```

   - Test the smart contracts using Mocha & OpenZeppelin Test Environment with the following command:

     ```sh

     $ npm test

     ```

   - Analyze the smart contracts using Slither with the following command (optional):

      ```sh

      $ slither .

      ```

   - Analyze the smart contracts using MythX CLI with the following command (optional):

     ```sh

     $ mythx analyze    

     ```

Deploy

======

## Deploying on Kovan's Testnet

  - Get an Ethereum Account on Metamask.

  - On the landing page, click “Get Chrome Extension.”

  - Create a .secret file cointaining the menomic.

  - Get some test ether from a [Kovan's faucet](https://faucet.kovan.network/).

  - Signup [Infura](https://infura.io/).

  - Create new project.

  - Copy the kovan URL into truffle-config.js.

  - Uncomment the following lines in truffle-config.js:

    ```

    // const HDWalletProvider = require("@truffle/hdwallet-provider");

    // const infuraKey = '...';

    // const infuraURL = 'https://rinkeby.infura.io/...';



    // const fs = require('fs');

    // const mnemonic = fs.readFileSync(".secret").toString().trim();

    ```

  - Install Truffle HD Wallet Provider:

    ```sh

    $ npm install @truffle/hdwallet-provider

    ```

  - Deploy the smart contract using Truffle & Infura with the following command:

    ```sh

    $ truffle migrate --network kovan

    ```

 ## Project (PoC) deployed on Rinkeby

 [AntsReview.sol](https://rinkeby.etherscan.io/address/0x6956dF88120c44fb446761947cD4B83b553F229F)  



 ## Project (MVP) deployed on Kovan  

 [AntsReview.sol](https://kovan.etherscan.io/address/0x85be8F04482cBB920550d5469E4dEdD6e1788121)  

 [ANTS.sol](https://kovan.etherscan.io/address/0x7395e83BC988F3f2A9413920D510eC7D47610D08)  

 [AntsFaucet.sol](https://kovan.etherscan.io/address/0xA7ea29C2994700f39801740bd0cf580f96997Dbd)



 Using the DApp

 ==============

  - Install [Ganache GUI](https://www.trufflesuite.com/ganache).

  - Change Ganache GUI port to 8545.

  - Import Ganache GUI mnemonic into MetaMask.

  - Connect MetaMask to Ganache GUI, adding a custom RPC specifing the Ganache GUI's RPC server URL.

  - Deploy the smart contracts to Ganache GUI:

    ```sh

    $ truffle migrate

    ```

  - Move to client directory on the project:

    ```sh

    $ cd client

    ```

  - Install dependencies:

    ```sh

    $ yarn install

    ```

  - Start the Local Web Server:

    ```sh

    $ npm run start

    ```  



Front-end

=========

- [PoC-UI](https://antsreview-poc.on.fleek.co)

- [MVP-UI](https://ants-review.on.fleek.co/)



Interacting with the PoC:

=========================



  - The User (Author) can issue a new AntReview, specifying:

    - IPFS Hash of requirements (e.g. QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4);

    - Timestamp of the deadline ([timestamp generator](https://www.unixtimestamp.com/));

    - Ether value of the AntReview reward (e.g. 1 ETH);

  - Switch Account on MetaMask (Peer-Reviewer) and Refresh the DApp.

  - Fulfill the AntReview by specifying the AntReview Id and the IPFS Hash of the peer-review.

  - Switch Account on MetaMask to the Issuer (Author) and Refresh the DApp.

  - Accept the Fulfillment (Peer-Review) by specifying the AntReview Id and Peer-Review Id.

  - The Peer-Reviewer Account will get the reward for the AntReview.

  - Switch Account on MetaMask to the Issuer (Author) and Refresh the DApp.

  - Cancel AntReview by specifying the AntReview Id (to be used after the deadline, if the AntReview has not received any fulfillments)

  - The Issuer will get back the reward of the AntReview Id specified.

  - Done.  



About

=====

## Inspiration & References



[![Awesome AntsReview](https://img.shields.io/badge/Awesome-AntsReview-orange)](https://github.com/naszam/awesome-antsreview/blob/master/README.md#references)



- [Standard Bounties](https://github.com/Bounties-Network/StandardBounties/blob/master/contracts/StandardBounties.sol)

- [Discover](https://github.com/dap-ps/discover/blob/master/contracts/Discover.sol)



## Authors

Project created by Team MetaBounty for ETHTurin 2020 Hackathon.  

*Research, Design* by [Bianca Trovò](https://www.linkedin.com/in/bianca-m-trovo/)  

*Smart Contracts and Architecture* by [Nazzareno Massari](http://nazzarenomassari.com)  

*UI/UX* by [Mitrasish Mukherjee](https://www.linkedin.com/in/mmitrasish/)  

*Pixel Art* by [Marcelo Colmenero](https://www.instagram.com/isometricpixelart/?hl=en)