Merge pull request #1 from robertleifke/robert/numo2

Adds robust testing and handling of the Numo invariant

Author: robertleifke

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+FROM mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm
+
+USER node
+
+# Install Bun
+RUN curl -fsSL https://bun.sh/install | bash
+
+# Install Foundry
+RUN curl -L https://foundry.paradigm.xyz | bash \
+  && /bin/bash -c "source ~/.bashrc && ~/.foundry/bin/foundryup"

.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+{
+  "name": "Foundry Template",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "NomicFoundation.hardhat-solidity",
+        "esbenp.prettier-vscode",
+        "PraneshASP.vscode-solidity-inspector",
+        "tamasfe.even-better-toml"
+      ]
+    }
+  },
+  "postCreateCommand": "bun install"
+}

.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,3 +1,5 @@
-PRIVATE_KEY=
-ETHERSCAN_API_KEY=
-BASE_SEPOLIA_RPC=
+export API_KEY_ALCHEMY="YOUR_API_KEY_ALCHEMY"
+export API_KEY_ETHERSCAN="YOUR_API_KEY_ETHERSCAN"
+export API_KEY_INFURA="YOUR_API_KEY_INFURA"
+export MNEMONIC="YOUR_MNEMONIC"
+export FOUNDRY_PROFILE="default"

.gas-snapshot

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Get input parameters
+GITHUB_REPOSITORY="$1"
+GITHUB_REPOSITORY_OWNER="$2"
+GITHUB_REPOSITORY_DESCRIPTION="$3"
+
+# Extract repository name from full repository path
+REPOSITORY_NAME=$(basename "$GITHUB_REPOSITORY")
+
+# Update package.json with new repository information
+if [ -f "package.json" ]; then
+    # Use sed to update package.json fields
+    sed -i.bak "s|\"name\": \".*\"|\"name\": \"$REPOSITORY_NAME\"|g" package.json
+    sed -i.bak "s|\"description\": \".*\"|\"description\": \"$GITHUB_REPOSITORY_DESCRIPTION\"|g" package.json
+    sed -i.bak "s|\"url\": \"git+https://github.com/.*/.*\\.git\"|\"url\": \"git+https://github.com/$GITHUB_REPOSITORY.git\"|g" package.json
+    sed -i.bak "s|\"homepage\": \"https://github.com/.*/.*#readme\"|\"homepage\": \"https://github.com/$GITHUB_REPOSITORY#readme\"|g" package.json
+    sed -i.bak "s|\"url\": \"https://github.com/.*/.*\\/issues\"|\"url\": \"https://github.com/$GITHUB_REPOSITORY/issues\"|g" package.json
+    
+    # Remove backup file
+    rm -f package.json.bak
+fi
+
+# Update README.md if it exists
+if [ -f "README.md" ]; then
+    sed -i.bak "1s/^# .*/# $REPOSITORY_NAME/" README.md
+    rm -f README.md.bak
+fi
+
+echo "Repository renamed to: $REPOSITORY_NAME"
+echo "Description: $GITHUB_REPOSITORY_DESCRIPTION"
+echo "Owner: $GITHUB_REPOSITORY_OWNER"

.github/scripts/rename.sh

@@ -0,0 +1,92 @@
+name: "CI"
+
+env:
+  API_KEY_ALCHEMY: ${{ secrets.API_KEY_ALCHEMY }}
+  FOUNDRY_PROFILE: "ci"
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  lint:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v4"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v1"
+
+      - name: "Install the Node.js dependencies"
+        run: "bun install"
+
+      - name: "Lint the code"
+        run: "bun run 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@v4"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v1"
+
+      - name: "Install the Node.js dependencies"
+        run: "bun install"
+
+      - 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@v4"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v1"
+
+      - name: "Install the Node.js dependencies"
+        run: "bun install"
+
+      - 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