build: use buidler + waffle + typescript (#211)

* refactor: use buidler+waffle
* refactor: curation test to ts
* refactor: serviceRegistry tests to ts
* refactor: graphtokens tests to ts
* refactor: epochManager tests to ts
* refactor: update disputeManager to ts and update typechain
* refactor: gns tests to ts
* refactor: staking tests to ts
* refactor: fix curation tests in ts
* build: build script improvements
* build: add truffle only for deployments, update README

Author: abarmat

.eslintrc

@@ -10,8 +10,7 @@
   "globals": {
     "artifacts": false,
     "contract": false,
-    "assert": false,
-    "web3": false
+    "assert": false
   },
   "rules": {
     // Strict mode

.prettierrc.json

@@ -13,6 +13,16 @@
         "explicitTypes": "always"
       }
     },
+    {
+      "files": "*.ts",
+      "options": {
+        "semi": false,
+        "trailingComma": "all",
+        "tabWidth": 2,
+        "singleQuote": true,
+        "explicitTypes": "always"
+      }
+    },
     {
       "files": "*.sol",
       "options": {

.solcover.js

@@ -1,4 +1,4 @@
-const skipFiles = ['bancor', 'bytes']
+const skipFiles = ['bancor', 'bytes', 'abdk-libraries-solidity']
 
 module.exports = {
   providerOptions: {

DEPLOYMENT.md

@@ -1,25 +1,58 @@
 ## Deploying the Solidity Smart Contracts via Truffle
 
-`/migrations/2_deploy_contracts.js` contains the parameters needed to deploy the contracts. Please edit these params as you see fit.
+### Running
+
+A script in `/migrations/2_deploy_contracts.js` deploys the contracts to the specified network.
+
+The script can be run with `npm run deploy`.
+
+### Networks
+
+By default, `npm run deploy` will deploy the contracts to the development network. To deploy to a different network run `npm run deploy -- --network {networkName}`, for example `npm run deploy -- --network ropsten`.
+
+- `{networkName}` must exist as valid network in the `truffle.js` config file.
+
+### Configuration
+
+A configuration file in the `/migrations/deploy.config.js` contains the parameters needed to deploy the contracts. Please edit these params as you see fit.
 
 ```
-const initialSupply = 1000000, // total supply of Graph Tokens at time of deployment
-  minimumCurationStakingAmount = 100, // minimum amount allowed to be staked by Market Curators
-  defaultReserveRatio = 500000, // reserve ratio (percent as PPM)
-  minimumIndexingStakingAmount = 100, // minimum amount allowed to be staked by Indexing Nodes
-  maximumIndexers = 10, // maximum number of Indexing Nodes staked higher than stake to consider
-  slashingPercentage = 10, // percent of stake to slash in successful dispute
-  thawingPeriod = 60 * 60 * 24 * 7, // amount of seconds to wait until indexer can finish stake logout
-  multiSigRequiredVote = 0, // votes required (setting a required amount here will override a formula used later)
-  multiSigOwners = [] // add addresses of the owners of the multisig contract here
-```
+const TOKEN_UNIT = new BN('10').pow(new BN('18'))
 
-The `MultiSigWallet` contract is deployed first in order to retain its address for use in deploying the remaining contracts.
+{
+  curation: {
+    reserveRatio: 500000,
+    minimumCurationStake: new BN('100').mul(TOKEN_UNIT),
+    withdrawalFeePercentage: 50000,
+  },
+  dispute: {
+    minimumDeposit: new BN('100').mul(TOKEN_UNIT),
+    fishermanRewardPercentage: 1000, // in basis points
+    slashingPercentage: 1000, // in basis points
+  },
+  epochs: {
+    lengthInBlocks: (24 * 60 * 60) / 15, // One day in blocks
+  },
+  staking: {
+    channelDisputeEpochs: 1,
+    maxAllocationEpochs: 5,
+    thawingPeriod: 20, // in blocks
+  },
+  token: {
+    initialSupply: new BN('10000000').mul(TOKEN_UNIT),
+  },
+}
+```
 
-The `Staking` contract requires both the address of the `MultiSigWallet` and the `GraphToken`.
+### Order of deployment
 
-The order of deployment is as follows:
+Due to some of the contracts require the address of other contracts, they are deployed in the following order:
 
-1. Deploy MultiSigWallet contract
-2. Deploy GraphToken Contract
-3. Deploy all remaining contracts with the address of the MultiSigWallet, and in the case of the `Staking` contract, use the `GraphToken` address retained previously.
+1. GraphToken
+2. EpochManager
+3. Curation
+4. Staking
+5. RewardsManager
+6. DisputeManager
+7. ServiceRegistry
+8. GNS

README.md

@@ -16,9 +16,7 @@ change whenever there are updates to the contract, and we need to redeploy. This
 done in sync with deploying a new subgraph. The new GNS should point `thegraph` domain to the
 latest subgraph.
 
-We want to also run some test scripts to populate data each time new contracts are deployed (WIP,
-Jorge has something that will work for this. Also, running the tests in this repo will populate
-data.
+We want to also run some test scripts to populate data each time new contracts are deployed.
 
 You will need two files to deploy anything and run `truffle`, they are `.privkey.txt` and
 `.infurakey.txt`. Privkey is a 12 word mneumonic, you should grab you 12 words from metamask, so
@@ -72,14 +70,14 @@ which will allow the subgraph to store data.
 to create and deploy subgraphs. It can be found [here](https://staging.thegraph.com/explorer/subgraph/graphprotocol/explorer-dapp)
 ]. The subgraph is already created, so we will only mention how to update the subgraph here.
 
-1. Deploy new contracts to Ropsten with `truffle deploy --network ropsten`. Truffle stores the
+1. Deploy new contracts to Ropsten with `npm run deploy -- --network ropsten`. Truffle stores the
    addresses for networks, so if you are trying to re-deploy you may have to run
-   `truffle networks —clean`, and then deploy
+   `truffle networks —clean`, and then deploy.
 2. Get the new contract addresses from the deployment. They are logged in the terminal output from
    deploying. Put these contract addresses into the subgraph manifest
 3. Make sure you are a member of `graphprotocol` for the staging explorer application
 4. Then make sure you have the right access token for `graphprotocol`. You can set this up with
-   `graph auth https://api.thegraph.com/deploy/ <ACCESS_TOKEN>`. You can get it from the dashbaord in the
+   `graph auth https://api.thegraph.com/deploy/ <ACCESS_TOKEN>`. You can get it from the dashboard in the
    UI, just pick `graphprotocol` instead of your own account, and you will see the token.
 5. Then in the `graph-network-subgraph` repository, just run `yarn deploy` to update a new version
 6. You will also have to update information in the `graph-explorer-dapp` repo. You must update
@@ -92,18 +90,15 @@ on ropsten, so we can better test.
 
 ## Installation &amp; Deployment of Contracts
 
-1. Install Node.js `^11.0.0`
-1. Run `npm install` at project root directory
-1. Install and run `testrpc`, `ganache-cli`, or similar blockchain emulator
-   - Configure to run on port `8545` or edit `truffle.js` to change the port used by Truffle
-1. Install Truffle 5.0.0
-   - `npm install -g truffle`
-1. Truffle project commands
-   - `truffle install` (installs ethPM dependencies)
-   - `truffle compile` (compiles without deploying, local blockchain emulator not neccessary)
-   - `truffle migrate [--reset] [--compile-all]` (deploys contracts to your local emulator or specified blockchain)
-   - `truffle test` (runs tests)
-1. See [DEPLOYMENT.md](./DEPLOYMENT.md) for instructions on deploying the contracts to the blockchain.
+1. Install Node.js `v10.15.1`.
+2. Run `npm install` at project root directory.
+3. Install and run `testrpc`, `ganache-cli`, or similar blockchain emulator.
+   - Configure to run on port `8545` or edit `truffle.js` to change the port used by Truffle.
+4. Build
+   - `npm run build` (compile contracts, flatten code, export ABIs and create Typescript bindings)
+   - `npm run deploy` (deploy contracts to local blockchain emulator)
+   - `npm run test` (runs tests)
+5. See [DEPLOYMENT.md](./DEPLOYMENT.md) for instructions on deploying the contracts to the blockchain.
 
 ## Abstract
 
@@ -112,30 +107,20 @@ This repository will contain the Solidity smart contracts needed to facilitate t
 
 ![Imgur](https://i.imgur.com/9uwiie1.png)
 
-## Graph Protocol Solidity Contracts
+## Graph Protocol Contracts
 
-1. [Graph Token Contract](./contracts/GraphToken.sol)
-1. [Staking / Dispute Resolution Contract](./contracts/Staking.sol)
-1. [Graph Name Service (GNS) Registry Contract](./contracts/GNS.sol)
-1. [Rewards Manager Contract](./contracts/RewardsManager.sol)
-1. [Service Registry Contract](./contracts/ServiceRegistry.sol)
-1. [Governance Contract](./contracts/Governed.sol)
+1. [Graph Token](./contracts/GraphToken.sol)
+2. [Staking](./contracts/Staking.sol)
+3. [Dispute Resolution](./contracts/DisputeManager.sol)
+4. [Graph Name Service (GNS)](./contracts/GNS.sol)
+5. [Rewards Manager](./contracts/RewardsManager.sol)
+6. [Service Registry](./contracts/ServiceRegistry.sol)
+7. [Governance](./contracts/Governed.sol)
 
 ### Supporting Contracts
 
 1. [MultiSig Contract](./contracts/MultiSigWallet.sol) (by Gnosis)
-1. [Detailed, Mintable, Burnable ERC20 Token](./contracts/openzeppelin/) (by Open Zeppelin)
-1. [Bonding Curve Formulas](./contracts/bancor/) (by Bancor)
-1. [Solidity-Bytes-Utils Library](./installed_contracts/bytes/) (by ConsenSys)
+2. [Detailed, Mintable, Burnable ERC20 Token](./contracts/openzeppelin/) (by Open Zeppelin)
+3. [Bonding Curve Formulas](./contracts/bancor/) (by Bancor)
 
 _[See ./contracts/README.md for full list of contracts](./contracts/)_
-
-## Requirement and Implementation Annotations
-
-Each contract includes docstring-like comments with requirements listed at the top of the file.
-
-Example: `@req c01 Any User can stake Graph Tokens to be included as a Curator for a given subgraphId.`
-
-Explanation: The `c01` denotes a section and number for the requirement. `c` in this case stands for `curation` and later in the contract we see `@req s01` used for a `staking` requirement.
-
-Farther down in the code you should see annotations for the implementation of each requirement written as `@imp c01` (and so on). This is meant to be a simple way of defining and matching requirements and their implementations.

buidler.config.ts

@@ -0,0 +1,49 @@
+import { BuidlerConfig, task, usePlugin } from '@nomiclabs/buidler/config'
+
+usePlugin('@nomiclabs/buidler-waffle')
+usePlugin('solidity-coverage')
+
+// This is a sample Buidler task. To learn how to create your own go to
+// https://buidler.dev/guides/create-task.html
+task('accounts', 'Prints the list of accounts', async (taskArgs, bre) => {
+  const accounts = await bre.ethers.getSigners()
+
+  for (const account of accounts) {
+    console.log(await account.getAddress())
+  }
+})
+
+// You have to export an object to set up your config
+// This object can have the following optional entries:
+// defaultNetwork, networks, solc, and paths.
+// Go to https://buidler.dev/config/ to learn more
+const config: BuidlerConfig = {
+  paths: {
+    sources: './contracts',
+    tests: './test',
+    artifacts: './build/contracts',
+  },
+  solc: {
+    version: '0.6.4',
+    optimizer: {
+      enabled: true,
+      runs: 500,
+    },
+  },
+  defaultNetwork: 'buidlerevm',
+  networks: {
+    buidlerevm: {
+      chainId: 31337,
+      loggingEnabled: false,
+      gas: 'auto',
+      gasPrice: 'auto',
+      blockGasLimit: 9500000,
+    },
+    ganache: {
+      chainId: 1337,
+      url: 'http://localhost:8545',
+    },
+  },
+}
+
+export default config