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.
소스 정보
- 저장소
- OpenZeppelin/openzeppelin-skills
- 최근 소스 활동
- 2026년 3월 4일 18:15
- 감지된 SKILL.md 언어
- 영어
- 스타
- 214
- 포크
- 33
설치 방법
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
소스 파일 검토
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
SKILL.md 표시 중
SKILL.md
소스 지침 · 읽기 전용 미리보기- name
- setup-solidity-contracts
- description
- 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
- metadata
- {"author":"OpenZeppelin"}
# 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.
GitHub에서 보기