[WIP] Integration tests

.env.example

@@ -0,0 +1,3 @@
+ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
+ROPSTEN_URL=https://eth-ropsten.alchemyapi.io/v2/<YOUR ALCHEMY KEY>
+PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1

.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+artifacts
+cache
+coverage

.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "standard",
+    "plugin:prettier/recommended",
+    "plugin:node/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      { ignores: ["modules"] },
+    ],
+  },
+};

.github/workflows/coverage.yml

@@ -0,0 +1,14 @@
+name: coverage 
+
+on: [push, pull_request]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out
+        uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: npm install
+      - run: npx hardhat coverage

.github/workflows/forge-test.yml

@@ -16,5 +16,9 @@ jobs:
         with:
           version: nightly
 
+      - name: Install packages (npm)
+        uses: actions/setup-node@v2
+        run: npm install
+
       - name: Run tests
         run: forge test -vvv

.gitignore

@@ -1,2 +1,12 @@
 cache/
 out/
+
+node_modules
+.env
+coverage
+coverage.json
+typechain
+
+#Hardhat files
+artifacts
+cache-hardhat/

.npmignore

@@ -0,0 +1,4 @@
+hardhat.config.ts
+scripts
+test
+cache-hardhat

.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json

.prettierrc

@@ -0,0 +1 @@
+{}

.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+    skipFiles: ["test", "mixin/HookInstrumentERC721.sol", "lib/HookStrings.sol"]
+  };

.solhint.json

@@ -1,3 +1,7 @@
 {
-  "extends": "solhint:default"
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
 }

.solhint.json.sol

@@ -0,0 +1,3 @@
+{
+  "extends": "solhint:default"
+}

.solhintignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -3,12 +3,69 @@
 [White paper draft](https://hook.art/wp-draft)
 
 ## Setup
+
 `forge install` to install dependencies from git submodules
+`npm install` to install hardhat dependencies
+
+the hardhat project is just used for coverage testing
+External non-test deps (ie openzeppelin contracts) are added using yarn,
+added to the `package.json` file, and then the {remappings.txt} is subsequently
+updated. `yarn add -D @openzeppelin/contracts`
 
 ## Testing
-`forge test` to run all tests
+
+`forge test` to run all forge tests
 `forge test --match-contract <Test Contract Name>` to run tests on a specific contract
+`npx hardhat test` to run integration tests
 
 ## Additional Forge Info
+
 [Foundry](https://github.com/foundry-rs/foundry)
 [Foundry Book](https://book.getfoundry.sh)
+
+# Advanced Sample Hardhat Project
+
+This project demonstrates an advanced Hardhat use case, integrating other tools commonly used alongside Hardhat in the ecosystem.
+
+The project comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts. It also comes with a variety of other tools, preconfigured to work with the project code.
+
+Try running some of the following tasks:
+
+```shell
+npx hardhat accounts
+npx hardhat compile
+npx hardhat clean
+npx hardhat test
+npx hardhat node
+npx hardhat help
+REPORT_GAS=true npx hardhat test
+npx hardhat coverage
+npx hardhat run scripts/deploy.ts
+TS_NODE_FILES=true npx ts-node scripts/deploy.ts
+npx eslint '**/*.{js,ts}'
+npx eslint '**/*.{js,ts}' --fix
+npx prettier '**/*.{json,sol,md}' --check
+npx prettier '**/*.{json,sol,md}' --write
+npx solhint 'contracts/**/*.sol'
+npx solhint 'contracts/**/*.sol' --fix
+```
+
+# Etherscan verification
+
+To try out Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Ropsten.
+
+In this project, copy the .env.example file to a file named .env, and then edit it to fill in the details. Enter your Etherscan API key, your Ropsten node URL (eg from Alchemy), and the private key of the account which will send the deployment transaction. With a valid .env file in place, first deploy your contract:
+
+```shell
+hardhat run --network ropsten scripts/deploy.ts
+```
+
+Then, copy the deployment address and paste it in to replace `DEPLOYED_CONTRACT_ADDRESS` in this command:
+
+```shell
+npx hardhat verify --network ropsten DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!"
+```
+
+# Performance optimizations
+
+For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable `TS_NODE_TRANSPILE_ONLY` to `1` in hardhat's environment. For more details see [the documentation](https://hardhat.org/guides/typescript.html#performance-optimizations).