How do I install the Setup Solidity Contracts skill?

Run npx skillmds add openzeppelin/setup-solidity-contracts in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Setup Solidity Contracts safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: makes network calls, reads secrets. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Setup Solidity Contracts?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Setup Solidity Contracts free to use?

Yes. Installing skills from SkillMD is free. This skill is licensed under AGPL-3.

Who published Setup Solidity Contracts?

openzeppelin (@openzeppelin) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Setup Solidity Contracts by openzeppelin

Name: Setup Solidity Contracts
Rating: 4.666666666666667 (3 reviews)
Author: openzeppelin

Setup Solidity Contracts

Set up a Solidity smart contract project with OpenZeppelin Contracts. Use when users need to: (1) create a new Hardhat or Foundry project, (2) install OpenZeppelin Contracts dependencies for Solidity, (3) configure remappings for Foundry, or (4) understand Solidity import conventions for OpenZeppelin.

File contents

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)

npx hardhat init        # Hardhat v2
npx hardhat --init      # Hardhat v3

Install OpenZeppelin Contracts:

npm install @openzeppelin/contracts

If using upgradeable contracts, also install the upgradeable variant:

npm install @openzeppelin/contracts-upgradeable

Foundry Setup

Install Foundry

curl -L https://foundry.paradigm.xyz | bash
foundryup

Initialize project (only if starting a new project)

forge init my-project
cd my-project

Add OpenZeppelin Contracts:

forge install OpenZeppelin/openzeppelin-contracts@v<VERSION>

If using upgradeable contracts, also add the upgradeable variant:

forge install OpenZeppelin/openzeppelin-contracts-upgradeable@v<VERSION>

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)

@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/

remappings.txt (if using upgradeable contracts)

@openzeppelin/contracts/=lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts/
@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/

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.

Import Conventions

Standard: @openzeppelin/contracts/token/ERC20/ERC20.sol
Upgradeable: @openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol
Use upgradeable variants only when deploying behind proxies; otherwise use standard contracts.

---name: setup-solidity-contractsdescription: Set up a Solidity smart contract project with OpenZeppelin Contracts. Use when users need to: (1) create a new Hardhat or Foundry project, (2) install OpenZeppelin Contracts dependencies for Solidity, (3) configure remappings for Foundry, or (4) understand Solidity import conventions for OpenZeppelin.license: AGPL-3.0-only--- # 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) ```bash npx hardhat init # Hardhat v2 npx hardhat --init # Hardhat v3 ``` - Install OpenZeppelin Contracts: ```bash npm install @openzeppelin/contracts ``` - If using upgradeable contracts, also install the upgradeable variant: ```bash npm install @openzeppelin/contracts-upgradeable ``` ## Foundry Setup - Install Foundry ```bash curl -L https://foundry.paradigm.xyz | bash foundryup ``` - Initialize project (only if starting a new project) ```bash forge init my-project cd my-project ``` - Add OpenZeppelin Contracts: ```bash forge install OpenZeppelin/openzeppelin-contracts@v<VERSION> ``` - If using upgradeable contracts, also add the upgradeable variant: ```bash forge install OpenZeppelin/openzeppelin-contracts-upgradeable@v<VERSION> ``` > 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) ```text @openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/ ``` - `remappings.txt` (if using upgradeable contracts) ```text @openzeppelin/contracts/=lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts/ @openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/ ``` > **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. ## Import Conventions - Standard: `@openzeppelin/contracts/token/ERC20/ERC20.sol` - Upgradeable: `@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol` - Use upgradeable variants only when deploying behind proxies; otherwise use standard contracts.

Frequently asked questions