Tasks: Add gas cost reports to CI (#117)

Co-authored-by: Facu Spagnuolo <facundo_spagnuolo@icloud.com>

Author: lgalende

.github/workflows/ci-tasks.yml

@@ -34,4 +34,8 @@ jobs:
       - name: Build
         run: yarn build
       - name: Test
-        run: yarn workspace @mimic-fi/v3-tasks test
+        run: REPORT_GAS=true yarn workspace @mimic-fi/v3-tasks test
+      - name: Gas Report
+        env:
+          CC_SECRET: ${{ secrets.CODECHECKS_SECRET }}
+        run: yarn workspace @mimic-fi/v3-tasks codechecks

.gitignore

@@ -5,4 +5,5 @@ build
 dist
 .certora_internal
 .certora_recent_jobs.json
+gasReporterOutput.json
 *.log

packages/tasks/codechecks.yml

@@ -0,0 +1,5 @@
+name: Codechecks
+description: Run codechecks for gas reports
+
+checks:
+  - name: eth-gas-reporter/codechecks

packages/tasks/hardhat.config.ts

@@ -2,6 +2,7 @@ import '@nomiclabs/hardhat-ethers'
 import '@nomiclabs/hardhat-waffle'
 import '@mimic-fi/v3-helpers/dist/tests'
 import 'hardhat-local-networks-config-plugin'
+import 'hardhat-gas-reporter'
 
 import { homedir } from 'os'
 import path from 'path'
@@ -17,4 +18,10 @@ export default {
       },
     },
   },
+  gasReporter: {
+    outputFile: 'gasReporterOutput.json',
+    enabled: !!process.env.REPORT_GAS,
+    noColors: true,
+    excludeContracts: ['Mock'],
+  },
 }

packages/tasks/package.json

@@ -31,6 +31,7 @@
     "@quant-finance/solidity-datetime": "2.2.0"
   },
   "devDependencies": {
+    "@codechecks/client": "^0.1.12",
     "@nomiclabs/hardhat-ethers": "^2.2.3",
     "@nomiclabs/hardhat-waffle": "2.0.3",
     "@types/chai": "^4.3.5",
@@ -41,6 +42,7 @@
     "ethereum-waffle": "^3.4.4",
     "ethers": "~5.6.0",
     "hardhat": "^2.14.1",
+    "hardhat-gas-reporter": "^1.0.9",
     "hardhat-local-networks-config-plugin": "^0.0.6",
     "mocha": "^10.2.0",
     "solhint-config-mimic": "^0.0.3",