Improved Natspec

.env.example

@@ -1,52 +1,39 @@
-# NETWORK AND ACCOUNT(s)
+# SECRETS (supply locally, never commit — also configurable via `vars`)
 # ---------------------------------------------------
-DEPLOYMENT_PRIVATE_KEY="0x0000000000000000000000000000000000000000000000000000000000000001"
-REFUND_ADDRESS=""
+DEPLOYER_KEY="0x0000000000000000000000000000000000000000000000000000000000000001"
+ETHERSCAN_API_KEY=""
 
-# Used by Foundry
-RPC_URL="https://sepolia.infura.io/v3/..."
-CHAIN_ID="11155111"
-
-# Used for log file names
-NETWORK_NAME="sepolia"
+# Pinata JWT, required by `just pin-metadata` / `just upgrade-proposal`
+PINATA_JWT=""
 
-# SOURCE VERIFICATION
+# OPTIONAL
 # ---------------------------------------------------
-VERIFIER="etherscan"
-# VERIFIER="blockscout"
-# VERIFIER="sourcify"
-# VERIFIER="routescan-mainnet" # (Etherscan compatible)
-# VERIFIER="routescan-testnet" # (Etherscan compatible)
 
-# ETHERSCAN_API_KEY="..."
-# BLOCKSCOUT_HOST_NAME="sepolia.explorer.mode.network"
+# Burner wallet: destination for `just refund`
+# REFUND_ADDRESS="0x..."
 
-# Deployed dependencies
-# ---------------------------------------------------
-# Used to deploy the contracts and to run fork tests.
-#
-# Pick the right addresses from:
-# https://github.com/aragon/osx/blob/main/packages/artifacts/src/addresses.json
-# https://github.com/aragon/token-voting-plugin/blob/main/npm-artifacts/src/addresses.json
+# Pin fork tests to a specific block
+# FORK_BLOCK_NUMBER=
 
-DAO_FACTORY_ADDRESS=""
-PLUGIN_REPO_FACTORY_ADDRESS=""
-PLUGIN_SETUP_PROCESSOR_ADDRESS=""
-
-# DEPLOYMENT PARAMETERS
+# PLUGIN SETTINGS (read by the deploy scripts under script/)
 # ---------------------------------------------------
 
-# New deployment
-PLUGIN_ENS_SUBDOMAIN="" # Optional (a random one is used if empty)
+# New deployment (DeployNewTokenVotingRepo)
 PLUGIN_REPO_MAINTAINER_ADDRESS=""
+PLUGIN_ENS_SUBDOMAIN="" # Optional (a random one is used if empty)
 
-# New version on a existing repo
-PLUGIN_REPO_ADDRESS=""
-MANAGEMENT_DAO_MULTISIG_ADDRESS=""
-
-# Metadata
-
+# New version on an existing repo (DeployTokenVoting_1_4 / upgrade-proposal).
+# TOKEN_VOTING_PLUGIN_REPO_ADDRESS and MANAGEMENT_DAO_MULTISIG_ADDRESS come from the active network file
+# (lib/just-foundry/networks/<network>.env); override per-network with `just switch <network> override` if needed.
 RELEASE_METADATA_URI=""
 BUILD_METADATA_URI=""
 
-PINATA_JWT=""
+# NETWORK CONFIG
+# ---------------------------------------------------
+# RPC_URL, CHAIN_ID, NETWORK_NAME, VERIFIER and the Aragon OSx addresses
+# (DAO_FACTORY_ADDRESS, PLUGIN_REPO_FACTORY_ADDRESS, PLUGIN_SETUP_PROCESSOR_ADDRESS,
+# MANAGEMENT_DAO_MULTISIG_ADDRESS, …) come from the active network in
+# lib/just-foundry/networks/<network>.env — select it with `just init <network>`
+# or `just switch <network>`, and inspect it with `just env`.
+# To override a value for one network: `just switch <network> override`,
+# then edit the generated .env.<network> file at the repo root.

.github/workflows/test.yml

@@ -39,6 +39,5 @@ jobs:
 
       - name: Run Forge tests
         run: |
-          cp .env.example .env
-          make test
+          forge test -vvv --no-match-path "./test/fork-tests/*.sol"
         id: test

.gitignore

@@ -3,16 +3,17 @@ cache
 coverage
 out
 zkout
+logs
 
 # Files
 .env
-.env-*
+.env.*
+!.env.example
 *.log
 .DS_Store
 lcov.info
 
 # Testing
-test/**/*.tree
 lcov.info
 report
 

.gitmodules

@@ -22,3 +22,6 @@
 [submodule "lib/plugin-version-1.3"]
 	path = lib/plugin-version-1.3
 	url = https://github.com/aragon/token-voting-plugin-hardhat
+[submodule "lib/just-foundry"]
+	path = lib/just-foundry
+	url = https://github.com/aragon/just-foundry.git

.vars.yaml

@@ -0,0 +1,9 @@
+# vars manifest — secrets this project resolves via `vars` (https://github.com/vars-cli/vars).
+# Only key NAMES live here; `vars` fetches the values from your configured backend.
+# `vars` is optional: without it, define these in .env instead (see .env.example).
+# just-foundry's recipes auto-run `vars resolve` when `vars` is installed and this file exists.
+keys:
+  - DEPLOYER_KEY
+  - ETHERSCAN_API_KEY
+  - PINATA_JWT
+  # - RPC_URL          # optional: override the network's default RPC with a private endpoint