Add containerization, lcov, fix env, scripts, aliases

.devcontainer.json

@@ -0,0 +1,25 @@
+{
+  "build": { "dockerfile": "Dockerfile" },
+
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "git.detectSubmodules": false,
+        "solidity.compileUsingRemoteVersion": "v0.8.20+commit.a1b79de6",
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "terminal.integrated.profiles.linux": {
+          "bash": {
+            "path": "/bin/bash"
+          }
+        }
+      },
+      "extensions": [
+        "NomicFoundation.hardhat-solidity",
+        "streetsidesoftware.code-spell-checker",
+        "tamasfe.even-better-toml",
+        "ms-vscode.makefile-tools",
+        "ryanluker.vscode-coverage-gutters"
+      ]
+    }
+  }
+}

.env.example

@@ -1,11 +1,11 @@
 # Deployer private key
-PRIVATE_KEY=YOUR PRIVATE KEY
+PRIVATE_KEY=YOUR_PRIVATE_KEY
 
 # RPC Endpoints
-INFURA_KEY=INFURA PROJECT ID
+INFURA_KEY=INFURA_PROJECT_ID
 
 # Additional keys
-ETHERSCAN_KEY=ETHERSCAN API KEY
-BSCSCAN_KEY=BSCSCAN API KEY
+ETHERSCAN_KEY=ETHERSCAN_API_KEY
+BSCSCAN_KEY=BSCSCAN_API_KEY
 
-COINMARKETCAP_KEY=COINMARKETCAP API KEY
+COINMARKETCAP_KEY=COINMARKETCAP_API_KEY

.github/actions/setup/action.yml

@@ -17,3 +17,6 @@ runs:
     - name: Install packages
       run: npm install
       shell: bash
+    - name: Install libs
+      run: npm run forge-install
+      shell: bash

.gitignore

@@ -1,4 +1,6 @@
 node_modules
+lib
+report
 .env
 .DS_Store
 
@@ -13,6 +15,8 @@ docs
 coverage
 coverage.json
 
+lcov.info
+
 # Typechain generated files
 generated-types
 

Dockerfile

@@ -0,0 +1,18 @@
+FROM ghcr.io/foundry-rs/foundry:latest as foundry
+
+RUN apk update
+
+FROM node:latest
+
+COPY --from=foundry /usr/local/bin/forge /usr/local/bin/forge
+COPY --from=foundry /usr/local/bin/cast /usr/local/bin/cast
+COPY --from=foundry /usr/local/bin/anvil /usr/local/bin/anvil
+COPY --from=foundry /usr/local/bin/chisel /usr/local/bin/chisel
+
+RUN apt-get update && apt-get install -y \
+  make \
+  lcov
+
+RUN npm install -g npm@latest
+
+ENTRYPOINT ["/bin/bash", "-c", "tail -F 'Wait for commands'"]

Makefile

@@ -0,0 +1,6 @@
+forge-install:
+	rm -rfv lib \
+	&& forge install --no-git foundry-rs/[email protected] \
+	&& forge install --no-git OpenZeppelin/[email protected] \
+	&& forge install --no-git OpenZeppelin/[email protected] \
+	&& forge install --no-git dl-solarity/solidity-lib

README.md

@@ -22,6 +22,9 @@ Third, use `npm` and `forge` to install the local dependencies
 npm install && forge install
 ```
 
+#### Or with Docker
+It is recommended to use the VSCode Dev Container for development. You can do this by opening the Command Palette `(Ctrl+Shift+P)` and selecting the `Dev Containers: Rebuild and Reopen in Container command`.
+
 ### How to use
 
 The template works out of the box. To clean up the repo, you may need to delete the mock contracts and tests.

foundry.toml

@@ -10,6 +10,8 @@ optimizer = true
 optimizer_runs = 200
 
 remappings = [
+    "@contracts/=./contracts/",
+    "@tests/=./tests/",
     "@openzeppelin/=lib/openzeppelin-contracts",
     "@openzeppelin-upgradeable/=lib/openzeppelin-contracts-upgradeable",
     "@solarity/=lib/solidity-lib",