SkillsAdd

openzeppelin/openzeppelin-skills

setup-solidity-contracts

Set up a Solidity smart contract project with OpenZeppelin Contracts.

First seen Mar 5, 2026

Installation

$ npx skills add openzeppelin/openzeppelin-skills --skill setup-solidity-contracts
View on skills.sh ↗ GitHub repository ↗

Summary

  • 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.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

typed-service-contracts Similar name
google-labs-code/design.md

Architecture standard for building robust, type-safe TypeScript services using the "Spec and Ha…

13 installs
documenting-contracts Similar name
riekelt/technical-writer

Use when documenting an HTTP API, message payloads, queue contracts, DTOs, file formats, or web…

5.1K installs
parallel-agent-contracts Similar name
parcadei/continuous-claude-v3

Parallel Agent Type Contracts

472 installs
deploying-contracts-on-base Similar name
base/skills

Deploys smart contracts to Base using Foundry. Covers forge create commands, contract verificat…

342 installs
qa-api-testing-contracts Similar name
vasilyu1983/ai-agents-public

API contract testing across REST, GraphQL, gRPC, AsyncAPI, webhooks, and workflow contracts. Us…

171 installs
web3-smart-contracts Similar name
maddhruv/absolute

Use this skill when writing, reviewing, auditing, or deploying Solidity smart contracts. Trigge…

136 installs

Also in this package

Other skills from openzeppelin/openzeppelin-skills · top by installs.

npx skills add openzeppelin/openzeppelin-skills
develop-secure-contracts 476 upgrade-solidity-contracts 417 setup-stellar-contracts 245 upgrade-stellar-contracts 220 setup-stylus-contracts 179 upgrade-stylus-contracts 177 upgrade-cairo-contracts 177 setup-cairo-contracts 171 review-sui-contracts 42 setup-sui-contracts 40

Browse all from openzeppelin/openzeppelin-skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 208
License LICENSE
Default branch main
Open issues 3
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

LicenseAGPL-3.0-only
More metadata
author
OpenZeppelin

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,805 B
  • docs SUMMARY.md 334 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 500 installs

SKILL.md

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.