Migration to hardhat (safe-fndn#256)

Author: rmeissner

.env.sample

@@ -1,2 +1,3 @@
 MNEMONIC=""
-INFURA_TOKEN=""
+INFURA_KEY=""
+ETHERSCAN_API_KEY=""

.github/workflows/ci.yml

@@ -1,7 +1,4 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
-name: Node.js Package
+name: safe-contracts
 on: [push, pull_request]
 
 jobs:
@@ -11,11 +8,15 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 12
+          node-version: 15
       - uses: actions/cache@v2
         with:
           path: '**/node_modules'
           key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
       - run: yarn
-      - run: yarn truffle compile
-      - run: yarn test
+      - run: yarn build
+      - run: yarn coverage
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -6,4 +6,7 @@ node_modules/
 env/
 .env
 bin/
-solc
+solc
+coverage/
+coverage.json
+yarn-error.log

.nvmrc

@@ -1 +1 @@
-v12.20.1
+v15.6.0

.solcover.js

@@ -0,0 +1,10 @@
+module.exports = {
+    skipFiles: [
+        'test/Token.sol',
+        'test/ERC1155Token.sol',
+    ],
+    mocha: {
+        grep: "@skip-on-coverage", // Find everything with this tag
+        invert: true               // Run the grep's inverse set.
+    }
+};

.solhint.json

@@ -0,0 +1,20 @@
+{
+    "extends": "solhint:recommended",
+    "plugins": [
+        "prettier"
+    ],
+    "rules": {
+        "compiler-version": "off",
+        "func-visibility": [
+            "warn",
+            {
+                "ignoreConstructors": true
+            }
+        ],
+        "prettier/prettier": "error",
+        "not-rely-on-time": "off",
+        "reason-string": "off",
+        "no-empty-blocks": "off",
+        "avoid-low-level-calls": "off"
+    }
+}

README.md

@@ -2,7 +2,8 @@ Gnosis Safe Contracts
 =====================
 
 [![npm version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-contracts.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-contracts)
-[![Build Status](https://travis-ci.org/gnosis/safe-contracts.svg?branch=development)](https://travis-ci.org/gnosis/safe-contracts)
+[![Build Status](https://github.com/gnosis/safe-contracts/workflows/safe-contracts/badge.svg?branch=development)](https://github.com/gnosis/safe-contracts/actions)
+[![Coverage Status](https://coveralls.io/repos/github/gnosis/safe-contracts/badge.svg?branch=feature/hardhat)](https://coveralls.io/github/gnosis/safe-contracts?branch=feature/hardhat)
 
 Install
 -------
@@ -12,44 +13,49 @@ Install
 yarn
 ```
 
-### Run all tests (requires Node version >=7 for `async/await`):
+### Run all tests:
 
 ```bash
-yarn truffle compile
+yarn build
 yarn test
 ```
 
-`yarn test` will start a ganache-cli with the correct configuration. If you want to run `yarn truffle test` you need to start a [ganache-cli](https://github.com/trufflesuite/ganache-cli) instance. For this it is required to use the [`--noVMErrorsOnRPCResponse`](https://github.com/trufflesuite/ganache-cli#options) option. This option will make sure that ganache-cli behaves the same as other clients (e.g. geth and parity) when handling reverting calls to contracts. This is required as some flows parse the error message (see https://gnosis-safe.readthedocs.io/en/latest/contracts/transactions.html#safe-transaction-gas-limit-estimation).
-
 ### Deploy
 
 Some contracts require that the Solidity compile target is at least `petersburg` (e.g. GnosisSafeProxyFactory and MultiSend). This is default since [Solidity 0.5.5](https://github.com/ethereum/solidity/releases/tag/v0.5.5).
 
 Note: The formal verification was performed using the contract compiled with solcjs 0.5.0.
 
-Preparation:
-- Set `INFURA_TOKEN` in `.env`
-- Set `NETWORK` in `.env`
-- Run `yarn truffle compile`
+This will deploy the contracts deterministically and verify the contracts on etherscan.
 
-Truffle:
+Preparation:
 - Set `MNEMONIC` in `.env`
+- Set `INFURA_KEY` in `.env`
 
 ```bash
-yarn truffle deploy
+yarn deploy-all <network>
 ```
 
-### Verify contract
-
-Note: To completely replicate the bytecode that has been deployed it is required that the project path is `/gnosis-safe` this can be archived using `sudo mkdir /gnosis-safe && sudo mount -B <your_repo_path> /gnosis-safe`. Make sure the run `yarn` again if the path has been changed after the inital `yarn install`. If you use a different path you will only get partial matches.
+This will perform the following steps
 
-You can locally verify contract using the scripts `generate_meta.js` and `verify_deployment.js`.
+```bash
+yarn build
+yarn deploy --network <network>
+yarn hardhat --network <network> etherscan-verify
+yarn hardhat --network <network> local-verify
+```
 
-With `node scripts/generate_meta.js` a `meta` folder is created in the `build` folder that contains all files required to verify the source code on https://verification.komputing.org/ and https://etherscan.io/
+### Verify contract
 
-For Etherscan only the `GnosisSafeEtherscan.json` file is required. For sourcify the `GnosisSafeMeta.json` and all the `.sol` files are required.
+This command will use the deployment artifacts to compile the contracts and compare them to the onchain code
+```bash
+yarn hardhat --network <network> local-verify
+```
 
-Once the meta data has been generated you can verify that your local compiled code corresponds to the version deployed by Gnosis with `yarn do <network> scripts/verify_deployment.js`.
+This command will upload the contract source to Etherescan
+```bash
+yarn hardhat --network <network> etherscan-verify
+```
 
 Documentation
 -------------
@@ -69,12 +75,4 @@ All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MER
 
 License
 -------
-All smart contracts are released under LGPL v.3.
-
-Contributors
-------------
-- Stefan George ([Georgi87](https://github.com/Georgi87))
-- Richard Meissner ([rmeissner](https://github.com/rmeissner))
-- Christian Lundkvist ([christianlundkvist](https://github.com/christianlundkvist))
-- Nick Dodson ([SilentCicero](https://github.com/SilentCicero))
-- Gonçalo Sá ([GNSPS](https://github.com/GNSPS))
+All smart contracts are released under LGPL-3.0

contracts/GnosisSafe.sol

@@ -1,4 +1,4 @@
-pragma solidity >=0.5.0 <0.7.0;
+pragma solidity >=0.5.0 <0.6.0;
 import "./base/ModuleManager.sol";
 import "./base/OwnerManager.sol";
 import "./base/FallbackManager.sol";
@@ -106,7 +106,7 @@ contract GnosisSafe
     /// @param data Data payload of Safe transaction.
     /// @param operation Operation type of Safe transaction.
     /// @param safeTxGas Gas that should be used for the Safe transaction.
-    /// @param baseGas Gas costs for that are indipendent of the transaction execution(e.g. base transaction fee, signature check, payment of the refund)
+    /// @param baseGas Gas costs that are independent of the transaction execution(e.g. base transaction fee, signature check, payment of the refund)
     /// @param gasPrice Gas price that should be used for the payment calculation.
     /// @param gasToken Token address (or 0 if ETH) that is used for the payment.
     /// @param refundReceiver Address of receiver of gas payment (or 0 if tx.origin).
@@ -359,8 +359,8 @@ contract GnosisSafe
     /// @param value Ether value.
     /// @param data Data payload.
     /// @param operation Operation type.
-    /// @param safeTxGas Fas that should be used for the safe transaction.
-    /// @param baseGas Gas costs for data used to trigger the safe transaction.
+    /// @param safeTxGas Gas that should be used for the safe transaction.
+    /// @param baseGas Gas costs for that are independent of the transaction execution(e.g. base transaction fee, signature check, payment of the refund)
     /// @param gasPrice Maximum gas price that should be used for this transaction.
     /// @param gasToken Token address (or 0 if ETH) that is used for the payment.
     /// @param refundReceiver Address of receiver of gas payment (or 0 if tx.origin).

contracts/Migrations.sol

@@ -1,4 +1,4 @@
-pragma solidity >=0.5.0 <0.7.0;
+pragma solidity >=0.5.0 <0.6.0;
 import "../common/Enum.sol";