restructure as monorepo

Author: jfschwarz

.github/workflows/ci.yml

@@ -13,6 +13,7 @@ jobs:
         with:
           path: "**/node_modules"
           key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+      - run: cd packages/contracts
       - run: yarn
       - run: yarn build
       - run: yarn coverage

.gitignore

@@ -1,10 +1,2 @@
-node_modules
-build
 .DS_Store
-artifacts/
-env/
-.env
-.openzeppelin
-coverage*
-deployments
-typechain-types
+node_modules

README.md

@@ -1,4 +1,8 @@
-# Token Lock Contract
+# Token Lock
+
+Lock ERC-20 token for a pre-defined amount of time
+
+## Contract
 
 [![Build Status](https://github.com/gnosis/token-lock/actions/workflows/ci.yml/badge.svg)](https://github.com/gnosis/token-lock/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/github/gnosis/token-lock/badge.svg?branch=master)](https://coveralls.io/github/gnosis/token-lock)
@@ -32,6 +36,7 @@ Deploys the implementation contract and an upgradable proxy.
 When run multiple times, it will create multiple proxies sharing the same implementation contract.
 
 ```
+cd packages/contracts
 yarn build
 yarn deploy rinkeby \
   --owner <OWNER> \
@@ -50,6 +55,7 @@ You can also find these values in .openzeppelin/<network>.json.
 Verifies the implementation contract at the specified address in Etherscan.
 
 ```
+cd packages/contracts
 yarn verify rinkeby --implementation <IMPLEMENTATION_CONTRACT>
 ```
 
@@ -61,6 +67,7 @@ This is done with a [simple click on a button](https://medium.com/etherscan-blog
 Deploys the latest version of the implementation contract (if necessary) and upgrades the existing proxy contract to use this one.
 
 ```
+cd packages/contracts
 yarn run upgrade rinkeby --proxy <PROXY_CONTRACT>
 ```
 
@@ -74,6 +81,10 @@ The contracts have been developed with [Solidity 0.8.6](https://github.com/ether
 
 All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-### License
+## App
+
+A front-end for the token lock contract based on next.js.
+
+## License
 
 Created under the [LGPL-3.0+ license](LICENSE).

package.json

@@ -1,79 +1,19 @@
 {
-  "name": "token-lock",
-  "version": "1.0.0",
+  "name": "token-lock-monorepo",
+  "private": true,
   "description": "Lock ERC-20 tokens for a pre-defined amount of time",
-  "directories": {
-    "test": "test"
-  },
   "scripts": {
-    "build": "hardhat compile",
-    "test": "hardhat test",
-    "test:watch": "mocha -w",
-    "deploy": "hardhat initialDeploy --network",
-    "verify": "hardhat verifyEtherscan --network",
-    "upgrade": "hardhat upgrade --network",
-    "coverage": "hardhat coverage",
-    "lint": "yarn lint:sol && yarn lint:ts",
-    "lint:sol": "solhint 'contracts/**/*.sol'",
-    "lint:ts": "eslint --max-warnings 0 .",
-    "fmt:sol": "prettier 'contracts/**/*.sol' -w",
-    "fmt:ts": "prettier '(src|test)/**/*.ts' -w",
-    "prepack": "yarn build",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "postinstall": "yarn contracts:install",
+    "contracts:install": "cd packages/contracts && yarn install",
+    "app:install": "cd packages/app && yarn install"
   },
   "repository": {
     "type": "git"
   },
   "author": "[email protected]",
   "license": "LGPL-3.0+",
   "devDependencies": {
-    "@gnosis.pm/zodiac": "1.0.3",
-    "@nomiclabs/hardhat-ethers": "2.0.3",
-    "@nomiclabs/hardhat-etherscan": "2.1.8",
-    "@nomiclabs/hardhat-waffle": "2.0.1",
-    "@openzeppelin/hardhat-upgrades": "1.12.0",
-    "@typechain/ethers-v5": "8.0.5",
-    "@typechain/hardhat": "3.1.0",
-    "@types/chai": "4.3.0",
-    "@types/dotenv": "8.2.0",
-    "@types/mocha": "9.0.0",
-    "@types/node": "17.0.8",
-    "@types/yargs": "17.0.8",
-    "@typescript-eslint/eslint-plugin": "5.9.0",
-    "@typescript-eslint/parser": "5.9.0",
-    "argv": "0.0.2",
-    "chai": "4.3.4",
-    "debug": "4.3.3",
-    "dotenv": "10.0.0",
-    "eslint": "8.6.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-no-only-tests": "2.6.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "ethereum-waffle": "3.4.0",
-    "ethers": "5.5.2",
-    "hardhat": "2.8.0",
-    "hardhat-deploy": "0.9.24",
-    "hardhat-gas-reporter": "1.0.6",
-    "husky": "7.0.4",
-    "prettier": "2.5.1",
-    "prettier-plugin-solidity": "1.0.0-beta.19",
-    "solc": "0.8.11",
-    "solhint": "3.3.6",
-    "solhint-plugin-prettier": "0.0.5",
-    "solidity-coverage": "0.7.17",
-    "ts-node": "10.4.0",
-    "typechain": "6.1.0",
-    "typescript": "4.5.4",
-    "yargs": "17.3.1"
-  },
-  "dependencies": {
-    "@gnosis.pm/mock-contract": "4.0.0",
-    "@gnosis.pm/safe-contracts": "1.3.0",
-    "@openzeppelin/contracts": "4.4.1",
-    "@openzeppelin/contracts-upgradeable": "4.4.1"
-  },
-  "resolutions": {
-    "bitcore-lib": "8.25.0"
+    "husky": "7.0.4"
   }
 }

.env.template renamed to packages/contracts/.env.template

@@ -0,0 +1,7 @@
+
+build/
+.openzeppelin/
+typechain-types/
+env
+.env
+coverage*