Merge pull request #1168 from graphprotocol/husky-update

fix: fix and upgrade Husky pre-commit, and add dev container config

Author: RembrandtK

.devcontainer/Dockerfile

@@ -0,0 +1,82 @@
+FROM mcr.microsoft.com/devcontainers/base:debian
+
+# Set non-interactive frontend for apt
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Switch to root for installing packages
+USER root
+
+RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
+
+# Install additional dependencies
+RUN apt update && apt install -y \
+    build-essential \
+    nodejs \
+    jq \
+    python3 \
+    python3-pip \
+    python3-venv \
+    pipx \
+    && apt clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Node.js
+RUN npm install -g n && n 20.12.0
+    
+# Install Solidity compiler using pipx (isolated environment)
+RUN pipx install solc-select && \
+    pipx ensurepath && \
+    /root/.local/bin/solc-select install 0.8.27 && \
+    /root/.local/bin/solc-select use 0.8.27 && \
+    # Copy binaries to /usr/local/bin with proper permissions (not symlinks)
+    cp /root/.local/bin/solc /usr/local/bin/solc && \
+    cp /root/.local/bin/solc-select /usr/local/bin/solc-select && \
+    chmod 755 /usr/local/bin/solc && \
+    chmod 755 /usr/local/bin/solc-select && \
+    # Make sure pipx directory is accessible
+    chmod -R a+rx /root/.local/pipx && \
+    # Set up for vscode user
+    mkdir -p /home/vscode/.solc-select && \
+    cp -r /root/.solc-select/* /home/vscode/.solc-select/ && \
+    chown -R vscode:vscode /home/vscode/.solc-select
+
+# Install Hardhat and related tools as root
+RUN npm install -g hardhat@2.22.16 @nomicfoundation/hardhat-ethers@3.0.8 ethers@6.13.4 && \
+    ln -sf /usr/local/lib/node_modules/hardhat/internal/cli/cli.js /usr/local/bin/hardhat && \
+    chmod +x /usr/local/bin/hardhat
+
+# Install Foundry for Anvil (as root for global installation)
+RUN curl -L https://foundry.paradigm.xyz | bash && \
+    /root/.foundry/bin/foundryup && \
+    # Copy binaries to /usr/local/bin with proper permissions
+    cp /root/.foundry/bin/anvil /usr/local/bin/anvil && \
+    cp /root/.foundry/bin/cast /usr/local/bin/cast && \
+    cp /root/.foundry/bin/forge /usr/local/bin/forge && \
+    cp /root/.foundry/bin/chisel /usr/local/bin/chisel && \
+    # Ensure proper permissions
+    chmod 755 /usr/local/bin/anvil && \
+    chmod 755 /usr/local/bin/cast && \
+    chmod 755 /usr/local/bin/forge && \
+    chmod 755 /usr/local/bin/chisel
+
+# Set up yarn
+RUN corepack enable && \
+    corepack prepare yarn@4.0.2 --activate
+
+# Ensure all users have access to the tools
+RUN chmod 755 /usr/local/bin/* && \
+    # Create a directory for vscode user's binaries
+    mkdir -p /home/vscode/.local/bin && \
+    chown -R vscode:vscode /home/vscode/.local/bin
+
+# Switch back to vscode user
+USER vscode
+
+# Set environment variables
+ENV PATH="/usr/local/bin:/home/vscode/.foundry/bin:/home/vscode/.local/bin:/root/.local/bin:$PATH"
+
+# Create .bashrc additions for PATH
+RUN echo 'export PATH="/usr/local/bin:$HOME/.local/bin:$PATH"' >> $HOME/.bashrc
+
+# Set the default command
+CMD ["sleep", "infinity"]

.devcontainer/README.md

@@ -0,0 +1,115 @@
+# Graph Protocol Contracts Dev Container
+
+This directory contains configuration files for the Graph Protocol contracts development container.
+
+> **Note:** This dev container setup is a work in progress and will not be fully portable.
+
+## Overview
+
+The dev container provides a consistent development environment with caching to improve performance.
+
+### Key Components
+
+1. **Docker Compose Configuration**: Defines the container setup, volume mounts, and environment variables
+2. **Dockerfile**: Specifies the container image and installed tools
+3. **project-setup.sh**: Configures the environment after container creation
+4. **host-setup.sh**: Sets up the host environment before starting the container
+5. **setup-git-signing.sh**: Automatically configures Git to use SSH signing with forwarded SSH keys
+
+## Cache System
+
+The container uses a simple caching system:
+
+1. **Host Cache Directories**: Created on the host and mounted into the container
+   - `/cache/vscode-cache` → `/home/vscode/.cache`
+   - `/cache/vscode-config` → `/home/vscode/.config`
+   - `/cache/vscode-data` → `/home/vscode/.local/share`
+   - `/cache/vscode-bin` → `/home/vscode/.local/bin`
+   - `/cache/*` → Tool-specific cache directories
+
+2. **Package Cache Symlinks**: Created inside the container by project-setup.sh
+   - Each package's cache directory is symlinked to a subdirectory in `/cache/hardhat`
+
+## Setup Instructions
+
+### 1. Host Setup (One-time)
+
+Before starting the dev container for the first time, run the included host setup script to create the necessary cache directories on the host:
+
+```bash
+sudo /git/graphprotocol/contracts/.devcontainer/host-setup.sh
+```
+
+This script creates all required cache directories on the host, including:
+
+- Standard VS Code directories (for .cache, .config, etc.)
+- Tool-specific cache directories (for npm, yarn, cargo, etc.)
+
+The script is idempotent and can be run multiple times without issues.
+
+### 2. Start the Dev Container
+
+After creating the cache directories, you can start the dev container:
+
+1. Open VS Code
+2. Use the "Remote-Containers: Open Folder in Container" command
+3. Select the repository directory
+
+When the container starts, the `project-setup.sh` script will automatically run and:
+
+- Create package-specific cache directories
+- Set up symlinks for package cache directories
+- Install project dependencies using yarn
+- Configure Git to use SSH signing with your forwarded SSH key
+- Source shell customizations if available in PATH (currently depends on base image configuration)
+
+## Environment Variables
+
+Environment variables are defined in two places:
+
+1. **docker-compose.yml**: Contains most of the environment variables for tools and caching
+2. **Environment File**: Personal settings are stored in `/opt/configs/graphprotocol/contracts.env`
+
+### Git Configuration
+
+To enable Git commit signing, add the following settings to your environment file:
+
+```env
+# Git settings for commit signing
+GIT_USER_NAME=Your Name
+GIT_USER_EMAIL=your.email@example.com
+```
+
+These environment variables are needed for Git commit signing to work properly. If they are not defined, Git commit signing will not be configured, but the container will still work for other purposes.
+
+## Troubleshooting
+
+If you encounter permission denied errors when trying to access directories, make sure you've run the `host-setup.sh` script on the host before starting the container:
+
+```bash
+sudo .devcontainer/host-setup.sh
+```
+
+### Git SSH Signing Issues
+
+If you encounter issues with Git SSH signing:
+
+1. **SSH Agent Forwarding**: Make sure SSH agent forwarding is properly set up in your VS Code settings
+2. **GitHub Configuration**: Ensure your SSH key is added to GitHub as a signing key in your account settings
+3. **Manual Setup**: If automatic setup fails, you can manually configure SSH signing:
+
+```bash
+# Check available SSH keys
+ssh-add -l
+
+# Configure Git to use SSH signing
+git config --global gpg.format ssh
+git config --global user.signingkey "key::ssh-ed25519 YOUR_KEY_CONTENT"
+git config --global gpg.ssh.allowedSignersFile ~/.ssh/allowed_signers
+git config --global commit.gpgsign true
+
+# Create allowed signers file
+echo "your.email@example.com ssh-ed25519 YOUR_KEY_CONTENT" > ~/.ssh/allowed_signers
+```
+
+For other issues, check the `project-setup.sh` and `setup-git-signing.sh` scripts for any errors.

.devcontainer/devcontainer.json

@@ -0,0 +1,44 @@
+{
+	"name": "graph contracts",
+	"dockerComposeFile": [
+		"docker-compose.yml"
+	],
+	"service": "dev-graph-contracts",
+	"features": {
+		"ghcr.io/devcontainers/features/git:1": {
+			"configureGitHubCLI": true,
+			"gitCredentialHelper": "cache"
+		},
+		"ghcr.io/devcontainers/features/github-cli:1": {},
+		"ghcr.io/devcontainers/features/common-utils:2.5.3": {},
+		"ghcr.io/devcontainers/features/node:1": {
+			"version": "20"
+		},
+		"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
+	},
+	"postCreateCommand": ".devcontainer/project-setup.sh",
+	"remoteUser": "vscode",
+	"workspaceFolder": "${localWorkspaceFolder}",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"rust-lang.rust-analyzer",
+				"tamasfe.even-better-toml",
+				"usernamehw.errorlens",
+				"yzhang.markdown-all-in-one",
+				"DavidAnson.vscode-markdownlint",
+				"shd101wyy.markdown-preview-enhanced",
+				"bierner.markdown-preview-github-styles",
+				"Gruntfuggly.todo-tree",
+				"ms-azuretools.vscode-docker",
+				"donjayamanne.githistory",
+				"eamodio.gitlens",
+				"fill-labs.dependi",
+				"streetsidesoftware.code-spell-checker",
+				"Augment.vscode-augment",
+				"NomicFoundation.hardhat-solidity",
+				"foundry-rs.foundry-vscode"
+			]
+		}
+	}
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,62 @@
+services:
+  dev-graph-contracts:
+    container_name: dev-graph-contracts
+    build:
+      context: .
+      dockerfile: Dockerfile
+      x-bake:
+        cache-from:
+          - type=local,src=/cache/docker
+        cache-to:
+          - type=local,dest=/cache/docker,mode=max
+    env_file:
+      - /opt/configs/graphprotocol/contracts.env
+    environment:
+      # Cache directories
+      - FOUNDRY_CACHE_DIR=/cache/foundry
+      - SOLC_CACHE=/cache/solidity
+
+      # GitHub
+      - GH_CONFIG_DIR=/cache/github
+
+      # XDG standard directories
+      - XDG_CACHE_HOME=/home/vscode/.cache
+      - XDG_CONFIG_HOME=/home/vscode/.config
+      - XDG_DATA_HOME=/home/vscode/.local/share
+
+      # Tool-specific settings
+      - HARDHAT_CACHE_DIR=/cache/hardhat
+      - HARDHAT_ANALYTICS=true
+      - HARDHAT_NO_ANALYTICS_PROMPT=true
+
+      # Node.js settings
+      - NPM_CONFIG_CACHE=/cache/npm
+      - YARN_CACHE_FOLDER=/cache/yarn
+      - NODE_OPTIONS=--max-old-space-size=4096
+
+      # Python settings
+      - PIP_CACHE_DIR=/cache/pip
+      - PYTHONPYCACHEPREFIX=/cache/pycache
+      - PYTHONDONTWRITEBYTECODE=1
+    networks:
+      - shared
+    volumes:
+      # Mount cache directory
+      - /cache:/cache
+
+      # System-specific mounts that need specific locations
+      - /cache/apt:/var/cache/apt
+      - /cache/apt-lib:/var/lib/apt
+
+      # Git repo root
+      - /git:/git
+
+      # Local cache directories for XDG standards
+      - /cache/vscode-cache:/home/vscode/.cache
+      - /cache/vscode-config:/home/vscode/.config
+      - /cache/vscode-data:/home/vscode/.local/share
+      - /cache/vscode-bin:/home/vscode/.local/bin
+
+networks:
+  shared:
+    external: true

.devcontainer/host-setup.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+# Host setup script for Graph Protocol Contracts dev container
+# Run this script on the host before starting the dev container
+# Usage: sudo .devcontainer/host-setup.sh
+
+set -euo pipefail
+
+echo "Setting up host environment for Graph Protocol Contracts dev container..."
+
+# Check if running as root
+if [ "$(id -u)" -ne 0 ]; then
+  echo "Error: This script must be run as root (sudo)" >&2
+  exit 1
+fi
+
+CACHE_DIRS=(
+  "/cache/vscode-cache"
+  "/cache/vscode-config"
+  "/cache/vscode-data"
+  "/cache/vscode-bin"
+  "/cache/hardhat"
+  "/cache/npm"
+  "/cache/yarn"
+  "/cache/pip"
+  "/cache/pycache"
+  "/cache/solidity"
+  "/cache/foundry"
+  "/cache/github"
+  "/cache/apt"
+  "/cache/apt-lib"
+)
+
+echo "Creating cache directories..."
+for dir in "${CACHE_DIRS[@]}"; do
+  if [ ! -d "$dir" ]; then
+    echo "Creating $dir"
+    mkdir -p "$dir"
+    chmod 777 "$dir"
+  else
+    echo "$dir already exists"
+  fi
+done
+
+# Note: Package-specific directories will be created by the project-setup.sh script
+# inside the container, as they are tied to the project structure
+
+echo "Host setup completed successfully!"
+echo "You can now start or rebuild your dev container."