foundry-template: Instructions file for Codex

AGENTS.md

Foundry-based template for developing Solidity smart contracts. Dependencies are managed as Node.js packages (via Bun) and remapped through remappings.txt instead of git submodules.

Toolchain

• solc is pinned to 0.8.37 (auto_detect_solc = false). The EVM target is unpinned, so it follows the installed Foundry's default (osaka as of Foundry 1.8); check the effective value with forge config | grep evm_version, and set evm_version in foundry.toml before deploying to a chain that lacks that hard fork.
• Pinned versions live in package.json (Forge Std, OpenZeppelin Contracts, Prettier, Solhint) and foundry.toml (compiler, optimizer, fuzz, formatter).

Commands

• bun install — install dependencies; required before building because forge-std lives in node_modules.
• bun run full-check — the CI lint gate: forge fmt --check, Solhint over {script,src,tests}/**/*.sol, and Prettier over **/*.{json,md,yml}. bun run full-write auto-fixes formatting (Solhint findings need manual fixes).
• forge build --sizes — the CI build step.
• FOUNDRY_PROFILE=ci forge test — reproduce CI's 10,000 fuzz runs and verbosity 4; plain forge test uses 1,000.
• forge script script/Deploy.s.sol --broadcast --fork-url http://localhost:8545 — deploy Foo to a local node with the BaseScript broadcaster.
• forge script script/DeployBrowser.s.sol --broadcast --fork-url http://localhost:8545 --browser — deploy through a browser wallet connected at localhost:9545.

Code Style

• forge fmt ([fmt] in foundry.toml), Solhint (.solhint.json), Prettier (.prettierrc.yml), and .editorconfig own formatting and lint rules; run the tools instead of hand-formatting.
• Every Solidity file carries an SPDX header; pragma is >=0.8.37 for contracts and >=0.8.37 <0.9.0 for tests and scripts.
• Import Forge Std through its src/ directory (forge-std/src/Test.sol), because the remapping points at the package root.

Conventions