Solidity Setup

For existing projects, detect the framework by looking for hardhat.config.* (Hardhat) or foundry.toml (Foundry). For new projects, ask the user which framework they prefer.

Hardhat Setup

• - Initialize project (only if starting a new project)

CODEBLOCK0

• - Install OpenZeppelin Contracts:

CODEBLOCK1

• - If using upgradeable contracts, also install the upgradeable variant:

CODEBLOCK2

Foundry Setup

• - Install Foundry

CODEBLOCK3

• - Initialize project (only if starting a new project)

CODEBLOCK4

• - Add OpenZeppelin Contracts:

CODEBLOCK5

• - If using upgradeable contracts, also add the upgradeable variant:

CODEBLOCK6

Look up the current version from https://github.com/OpenZeppelin/openzeppelin-contracts/releases. Pin to a release tag — without one, forge install pulls the default branch, which may be unstable.

• - remappings.txt (if not using upgradeable contracts)

CODEBLOCK7

• - remappings.txt (if using upgradeable contracts)

CODEBLOCK8

Note
The above remappings mean that both @openzeppelin/contracts/ (including proxy contracts) and @openzeppelin/contracts-upgradeable/ come from the openzeppelin-contracts-upgradeable submodule and its subdirectories, which includes its own transitive copy of openzeppelin-contracts of the same release version number. This format is needed for Etherscan verification to work. Particularly, any copies of openzeppelin-contracts that are installed separately are NOT used.

Compiler version: OpenZeppelin Contracts v5 requires pragma solidity ^0.8.20. If deploying to chains that do not support the PUSH0 opcode (some L2s), set the EVM version to paris in the compiler configuration (e.g., evmVersion: "paris" in Hardhat, evm_version = "paris" in foundry.toml).

Import Conventions

• - Standard: INLINECODE16
• Upgradeable: INLINECODE17
• Use upgradeable variants only when deploying behind proxies; otherwise use standard contracts.