Skip to content

v3.27.0 — web3 project-type overlay

Choose a tag to compare

@zigrivers zigrivers released this 12 May 13:29
· 298 commits to main since this release
9e4a9fa

Web3 Project-Type Overlay

scaffold init --project-type web3 targets smart-contract / protocol teams shipping to EVM chains (Foundry / Hardhat) with audit-discipline workflows. Implements roadmap "Content & Quality > New Project Type Overlays" for the W3-1 audience.

Added

  • New overlay: content/methodology/web3-overlay.yml injects 14 web3 knowledge documents into 22 universal pipeline steps (requirements, conventions, project-structure, dev-environment, security, testing, architecture, access-control, upgradeability, gas-optimization, oracles, audit-workflow, common-vulnerabilities, deployment).
  • Brownfield detector: medium-tier for foundry.toml and hardhat.config.{ts,js,cjs,mjs}; low-tier for remappings.txt and lib/forge-std. EVM-only scope.
  • Forward-compatible schema: Web3Config.scope: 'contracts' with .default('contracts') — W3-2 (dApp) will extend the enum additively.
  • Wiring: schema + coupling validator + detector + wizard copy + adopt mapping + PROJECT_TYPE_PREFERENCE entry.
  • Web3-vs-library boundary: 3-scenario resolve-detection.test.ts regression pins behavior (foundry-only → web3; typical Hardhat → web3; published-library Hardhat → library via high-vs-medium tiebreak).
  • New tests: content eval (web3-overlay-content.bats) with 14 keyword checks; 8-test E2E block extending project-type overlay suite.

Upgrade

```
npm update -g @zigrivers/scaffold

or

brew upgrade scaffold
```

Backlog

W3-2 (web3 application / dApp) and non-EVM chains (Solana, Move-based) are tracked in `docs/roadmap.md` under Backlog / Later.

PR: #338.