setup-solidity-contracts

What problem does it solve?

Helps developers create or configure Solidity projects that use OpenZeppelin Contracts by reducing friction around framework detection, dependency installation, remapping configuration, and import conventions for upgradeable versus standard contracts.

Core Features & Use Cases

• Framework detection and initialization: Guides whether to initialize Hardhat or Foundry projects and what to check in existing repositories.
• Dependency installation: Explains how to add @openzeppelin contracts packages for npm and Foundry, and when to include upgradeable variants.
• Remappings and import guidance: Provides the remappings format and import conventions needed for correct compilation and Etherscan verification when using Foundry and upgradeable layouts.
• Use Case: Set up a new Foundry repository, install OpenZeppelin contracts, and configure remappings so proxy and upgradeable imports resolve correctly for verification.

Quick Start

Create a new Hardhat or Foundry project, install the appropriate @openzeppelin contracts packages including upgradeable variants when deploying behind proxies, and add the recommended remappings so imports resolve for local builds and verification.