feat: hybrid-foundry-hardhat (#20)

Author: roderik

.env.example

@@ -1,5 +1,23 @@
+node_modules
+.env
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json
+
+# Hardhat Ignition default folder for deployments against a local node
+ignition/deployments/chain-31337
+
 # Compiler files
-cache/
+cache_forge/
 out/
 
 # Ignores development broadcast logs
@@ -14,11 +32,7 @@ docs/
 .env
 
 # Subgraphs
-deployment.txt
-deployment-anvil.txt
-subgraph/subgraph.config.json
-subgraph/node_modules
-subgraph/generated
-subgraph/build
+generated
+build
 
 .pnpm

.gitignore

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

.solhint.json

@@ -3,7 +3,6 @@
     "nomicfoundation.hardhat-solidity",
     "genieai.chatgpt-vscode",
     "esbenp.prettier-vscode",
-    "dracula-theme.theme-dracula",
     "cnshenj.vscode-task-manager",
     "catppuccin.catppuccin-vsc-icons",
     "catppuccin.catppuccin-vsc"

.vscode/extensions.json

@@ -2,101 +2,84 @@
   "version": "2.0.0",
   "tasks": [
     {
-      "label": "build",
+      "label": "Foundry - Build",
       "type": "shell",
-      "command": "make build",
+      "command": "btp-scs foundry build",
       "group": {
         "kind": "build",
         "isDefault": true
       },
       "problemMatcher": []
     },
     {
-      "label": "test",
+      "label": "Hardhat - Build",
       "type": "shell",
-      "command": "make test",
-      "group": "test",
+      "command": "btp-scs hardhat build",
+      "group": {
+        "kind": "build",
+        "isDefault": false
+      },
       "problemMatcher": []
     },
     {
-      "label": "format",
+      "label": "Foundry - Test",
       "type": "shell",
-      "command": "make format",
+      "command": "btp-scs foundry test",
+      "group": "test",
       "problemMatcher": []
     },
     {
-      "label": "snapshot",
+      "label": "Hardhat - Test",
       "type": "shell",
-      "command": "make snapshot",
+      "command": "btp-scs hardhat test",
+      "group": "test",
       "problemMatcher": []
     },
     {
-      "label": "anvil",
+      "label": "Foundry - Format",
       "type": "shell",
-      "command": "make anvil",
+      "command": "btp-scs foundry format",
       "problemMatcher": []
     },
     {
-      "label": "deploy-anvil",
+      "label": "Foundry - Start network",
       "type": "shell",
-      "command": "make deploy-anvil",
-      "problemMatcher": []
+      "command": "btp-scs foundry network",
+      "problemMatcher": [],
+      "isBackground": true
     },
     {
-      "label": "deploy-btp",
+      "label": "Hardhat - Start network",
       "type": "shell",
-      "command": "EXTRA_ARGS=\"${input:extra-deployment-verify} ${input:extra-deployment-other}\" make deploy-btp",
-      "problemMatcher": []
+      "command": "btp-scs hardhat network",
+      "problemMatcher": [],
+      "isBackground": true,
     },
     {
-      "label": "script-anvil",
+      "label": "Hardhat - Deploy to local network",
       "type": "shell",
-      "command": "EXTRA_ARGS=\"${input:extra-script-broadcast} ${input:extra-script-other}\" make script-anvil",
+      "command": "btp-scs hardhat deploy local -m ${input:deployment-module}",
       "problemMatcher": []
     },
     {
-      "label": "script",
+      "label": "Hardhat - Deploy to platform network",
       "type": "shell",
-      "command": "EXTRA_ARGS=\"${input:extra-script-broadcast} ${input:extra-script-other}\" make script",
+      "command": "btp-scs hardhat deploy remote -m ${input:deployment-module}",
       "problemMatcher": []
     },
     {
-      "label": "help",
+      "label": "The Graph - Deploy or update the subgraph",
       "type": "shell",
-      "command": "make help",
+      "command": "btp-scs subgraph deploy",
       "problemMatcher": []
     }
   ],
   "inputs": [
     {
-      "id": "extra-deployment-verify",
-      "description": "Extra deployment options?",
-      "default": "",
-      "type": "pickString",
-      "options": [
-        "",
-        "--verify --verifier sourcify",
-        "--verify --verifier etherscan --etherscan-api-key ${ETHERSCAN_API_KEY}"
-      ]
-    },
-    {
-      "id": "extra-deployment-other",
-      "description": "Other extra deployment options?",
-      "default": "",
-      "type": "promptString"
-    },
-    {
-      "id": "extra-script-broadcast",
-      "description": "Broadcast?",
-      "default": "",
-      "type": "pickString",
-      "options": ["", "--broadcast"]
-    },
-    {
-      "id": "extra-script-other",
-      "description": "Other extra script options?",
-      "default": "",
-      "type": "promptString"
+      "id": "deployment-module",
+      "description": "Hardhat Ignition Module",
+      "type": "promptString",
+      "default": "ignition/modules/Counter.ts"
     }
   ]
 }

.vscode/tasks.json

@@ -2,19 +2,23 @@ FROM node:20.13.1-bookworm as build
 
 ENV FOUNDRY_DIR /usr/local
 RUN curl -L https://foundry.paradigm.xyz | bash && \
-  /usr/local/bin/foundryup --version nightly-f625d0fa7c51e65b4bf1e8f7931cd1c6e2e285e9
+  /usr/local/bin/foundryup
 
 WORKDIR /
 
-RUN git config --global user.email "[email protected]" && \
-  git config --global user.name "SettleMint" && \
-  forge init usecase --template settlemint/solidity-empty && \
-  cd usecase && \
-  forge build
+COPY . /usecase
+
+WORKDIR /usecase
 
 USER root
 
+RUN forge build
+
+RUN npm install
+RUN npx hardhat compile
+
 FROM cgr.dev/chainguard/busybox:latest
 
 COPY --from=build /usecase /usecase
 COPY --from=build /root/.svm /usecase-svm
+COPY --from=build /root/.cache /usecase-cache

Dockerfile

@@ -12,7 +12,7 @@ If you want to use it separately, bootstrap a new project using
 forge init my-erc20-token --template settlemint/solidity-token-erc20
 ```
 
-## DX: Foundry
+## DX: Foundry & Hardhat hybrid
 
 **Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
 
@@ -23,6 +23,14 @@ Foundry consists of:
 - **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
 - **Chisel**: Fast, utilitarian, and verbose solidity REPL.
 
+**Hardhat is a Flexible, Extensible, Fast Ethereum development environment for professionals in typescript**
+
+Hardhat consists of:
+
+- **Hardhat Runner**: Hardhat Runner is the main component you interact with when using Hardhat. It's a flexible and extensible task runner that helps you manage and automate the recurring tasks inherent to developing smart contracts and dApps.
+- **Hardhat Ignition**: Declarative deployment system that enables you to deploy your smart contracts without navigating the mechanics of the deployment process.
+- **Hardhat Network**: Declarative deployment system that enables you to deploy your smart contracts without navigating the mechanics of the deployment process.
+
 ## Documentation
 
 - https://console.settlemint.com/documentation/docs/using-platform/integrated-development-environment/

Makefile

@@ -2,6 +2,8 @@
 pragma solidity 0.8.26;
 
 contract Counter {
+    event CounterIncremented(uint256 indexed newValue);
+
     uint256 public number;
 
     function setNumber(uint256 newNumber) public {
@@ -10,5 +12,6 @@ contract Counter {
 
     function increment() public {
         number++;
+        emit CounterIncremented(number);
     }
 }

README.md

@@ -13,14 +13,15 @@
   wrap_comments = true
 
 [rpc_endpoints]
-anvil = "http://localhost:8545"
-btp = "${BTP_RPC_URL}"
+  anvil = "http://localhost:8545"
+  btp = "${BTP_RPC_URL}"
 
 [profile.default]
-  src = "src"
-  test = "test"
-  out = "out"
-  libs = ["lib"]
+  src = 'contracts'
+  out = 'out'
+  libs = ['node_modules', 'lib']
+  test = 'test'
+  cache_path  = 'cache_forge'
   solc = "0.8.26"
   optimizer = true
   optimizer_runs = 10_000