chore: move to vacp2p/foundry-template

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig  http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sol]
+indent_size = 4
+
+[*.tree]
+indent_size = 1

.env.example

@@ -1,4 +1,11 @@
-ETHERSCAN_API_KEY=<YOUR_ETHERSCAN_KEY>
-SEPOLIA_URL=https://eth-sepolia.alchemyapi.io/v2/<YOUR ALCHEMY KEY>
-POLYGON_ZKEVM_TESTNET_URL=https://rpc.public.zkevm-test.net
-PRIVATE_KEY=<YOUR_PRIVATE_KEY>
+export API_KEY_ALCHEMY="YOUR_API_KEY_ALCHEMY"
+export API_KEY_ARBISCAN="YOUR_API_KEY_ARBISCAN"
+export API_KEY_BSCSCAN="YOUR_API_KEY_BSCSCAN"
+export API_KEY_ETHERSCAN="YOUR_API_KEY_ETHERSCAN"
+export API_KEY_GNOSISSCAN="YOUR_API_KEY_GNOSISSCAN"
+export API_KEY_INFURA="YOUR_API_KEY_INFURA"
+export API_KEY_OPTIMISTIC_ETHERSCAN="YOUR_API_KEY_OPTIMISTIC_ETHERSCAN"
+export API_KEY_POLYGONSCAN="YOUR_API_KEY_POLYGONSCAN"
+export API_KEY_SNOWTRACE="YOUR_API_KEY_SNOWTRACE"
+export MNEMONIC="YOUR_MNEMONIC"
+export FOUNDRY_PROFILE="default"

.gas-snapshot

@@ -0,0 +1 @@
+FooTest:test_Example() (gas: 8662)

.gitattributes

@@ -0,0 +1 @@
+lib/** linguist-vendored

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Description
+
+Describe the changes made in your pull request here.
+
+## Checklist
+
+Ensure you completed **all of the steps** below before submitting your pull request:
+
+- [ ] Added natspec comments?
+- [ ] Ran `forge snapshot`?
+- [ ] Ran `pnpm lint`?
+- [ ] Ran `forge test`?
+- [ ] Ran `pnpm verify`?

.github/scripts/rename.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+# https://gist.github.com/vncsna/64825d5609c146e80de8b1fd623011ca
+set -euo pipefail
+
+# Define the input vars
+GITHUB_REPOSITORY=${1?Error: Please pass username/repo, e.g. prb/foundry-template}
+GITHUB_REPOSITORY_OWNER=${2?Error: Please pass username, e.g. prb}
+GITHUB_REPOSITORY_DESCRIPTION=${3:-""} # If null then replace with empty string
+
+echo "GITHUB_REPOSITORY: $GITHUB_REPOSITORY"
+echo "GITHUB_REPOSITORY_OWNER: $GITHUB_REPOSITORY_OWNER"
+echo "GITHUB_REPOSITORY_DESCRIPTION: $GITHUB_REPOSITORY_DESCRIPTION"
+
+# jq is like sed for JSON data
+JQ_OUTPUT=`jq \
+  --arg NAME "@$GITHUB_REPOSITORY" \
+  --arg AUTHOR_NAME "$GITHUB_REPOSITORY_OWNER" \
+  --arg URL "https://github.com/$GITHUB_REPOSITORY_OWNER" \
+  --arg DESCRIPTION "$GITHUB_REPOSITORY_DESCRIPTION" \
+  '.name = $NAME | .description = $DESCRIPTION | .author |= ( .name = $AUTHOR_NAME | .url = $URL )' \
+  package.json
+`
+
+# Overwrite package.json
+echo "$JQ_OUTPUT" > package.json
+
+# Make sed command compatible in both Mac and Linux environments
+# Reference: https://stackoverflow.com/a/38595160/8696958
+sedi () {
+  sed --version >/dev/null 2>&1 && sed -i -- "$@" || sed -i "" "$@"
+}
+
+# Rename instances of "vacp2p/foundry-template" to the new repo name in README.md for badges only
+sedi "/gha/ s|vacp2p/foundry-template|"${GITHUB_REPOSITORY}"|;" "README.md"
+sedi "/gha-badge/ s|vacp2p/foundry-template|"${GITHUB_REPOSITORY}"|;" "README.md"

.github/workflows/ci.yml

@@ -1,60 +1,167 @@
-name: CI
+name: "CI"
 
-on:
-  push:
-    branches: [main]
-    paths:
-      - "**.sol"
-      - "scripts/**.ts"
-      - "test/**.ts"
-      - "hardhat.config.ts"
-      - "package.json"
-      - ".github/workflows/ci.yml"
+env:
+  API_KEY_ALCHEMY: ${{ secrets.API_KEY_ALCHEMY }}
+  FOUNDRY_PROFILE: "ci"
 
+on:
+  workflow_dispatch:
   pull_request:
-    branches: [main]
-    paths:
-      - "**.sol"
-      - "scripts/**.ts"
-      - "test/**.ts"
-      - "hardhat.config.ts"
-      - "package.json"
-      - ".github/workflows/ci.yml"
+  push:
+    branches:
+      - "main"
 
 jobs:
+  lint:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Install Pnpm"
+        uses: "pnpm/action-setup@v2"
+        with:
+          version: "8"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
+        with:
+          cache: "pnpm"
+          node-version: "lts/*"
+
+      - name: "Install the Node.js dependencies"
+        run: "pnpm install"
+
+      - name: "Lint the contracts"
+        run: "pnpm lint"
+
+      - name: "Add lint summary"
+        run: |
+          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  build:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Build the contracts and print their size"
+        run: "forge build --sizes"
+
+      - name: "Add build summary"
+        run: |
+          echo "## Build result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
   test:
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Show the Foundry config"
+        run: "forge config"
+
+      - name: "Generate a fuzz seed that changes weekly to avoid burning through RPC allowance"
+        run: >
+          echo "FOUNDRY_FUZZ_SEED=$(
+            echo $(($EPOCHSECONDS - $EPOCHSECONDS % 604800))
+          )" >> $GITHUB_ENV
+
+      - name: "Run the tests"
+        run: "forge test"
+
+      - name: "Add test summary"
+        run: |
+          echo "## Tests result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  coverage:
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Generate the coverage report using the unit and the integration tests"
+        run: 'forge coverage --match-path "test/**/*.sol" --report lcov'
+
+      - name: "Upload coverage report to Codecov"
+        uses: "codecov/codecov-action@v3"
+        with:
+          files: "./lcov.info"
+
+      - name: "Add coverage summary"
+        run: |
+          echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY
+  verify:
+    needs: ["lint", "build"]
     runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: nightly
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with: { python-version: 3.9 }
 
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: "yarn"
-      - id: dependencies
-        run: yarn install
+      - name: Install Java
+        uses: actions/setup-java@v1
+        with: { java-version: "11", java-package: jre }
 
-      - id: lint
-        run: yarn lint
+      - name: Install Certora CLI
+        run: pip3 install certora-cli==5.0.5
 
-      - id: test
-        run: yarn test:verbose
+      - name: Install Solidity
+        run: |
+          wget https://github.com/ethereum/solidity/releases/download/v0.8.20/solc-static-linux
+          chmod +x solc-static-linux
+          sudo mv solc-static-linux /usr/local/bin/solc
 
-      - id: coverage
-        run: yarn coverage
+      - name: "Install Pnpm"
+        uses: "pnpm/action-setup@v2"
+        with:
+          version: "8"
 
-      - id: upload-coverage
-        # run only in pull requests
-        if: github.event_name == 'pull_request'
-        uses: zgosalvez/github-actions-report-lcov@v1
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          coverage-files: lcov.info
-          artifact-name: code-coverage-report
+          cache: "pnpm"
+          node-version: "lts/*"
+
+      - name: "Install the Node.js dependencies"
+        run: "pnpm install"
+
+      - name: Verify rules
+        run: "pnpm verify"
+        env:
+          CERTORAKEY: ${{ secrets.CERTORAKEY }}
+
+    strategy:
+      fail-fast: false
+      max-parallel: 16

.github/workflows/create.yml

@@ -0,0 +1,52 @@
+name: "Create"
+
+# The workflow will run only when the "Use this template" button is used
+on:
+  create:
+
+jobs:
+  create:
+    # We only run this action when the repository isn't the template repository. References:
+    # - https://docs.github.com/en/actions/learn-github-actions/contexts
+    # - https://docs.github.com/en/actions/learn-github-actions/expressions
+    if: ${{ !github.event.repository.is_template }}
+    permissions: "write-all"
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+
+      - name: "Update package.json"
+        env:
+          GITHUB_REPOSITORY_DESCRIPTION: ${{ github.event.repository.description }}
+        run:
+          ./.github/scripts/rename.sh "$GITHUB_REPOSITORY" "$GITHUB_REPOSITORY_OWNER" "$GITHUB_REPOSITORY_DESCRIPTION"
+
+      - name: "Add rename summary"
+        run: |
+          echo "## Commit result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+      - name: "Remove files not needed in the user's copy of the template"
+        run: |
+          rm -f "./.github/FUNDING.yml"
+          rm -f "./.github/scripts/rename.sh"
+          rm -f "./.github/workflows/create.yml"
+
+      - name: "Add remove summary"
+        run: |
+          echo "## Remove result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+      - name: "Update commit"
+        uses: "stefanzweifel/git-auto-commit-action@v4"
+        with:
+          commit_message: "feat: initial commit"
+          commit_options: "--amend"
+          push_options: "--force"
+          skip_fetch: true
+
+      - name: "Add commit summary"
+        run: |
+          echo "## Commit result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -1,14 +1,19 @@
-node_modules
-.env
-coverage
-coverage.json
-typechain
-
-#Hardhat files
+# directories
 cache
-artifacts
-
-#Foundry files
-cache_forge
+node_modules
 out
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
 lcov.info
+yarn.lock
+
+# broadcasts
+!broadcast
+broadcast/*
+broadcast/*/31337/
+
+.certora_internal

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "lib/forge-std"]
+  branch = "v1"
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
-	branch = v1.6.0