openzeppelin
Develop smart contracts using OpenZeppelin Contracts library. Use when the user wants to create or modify Solidity contracts that use OpenZeppelin — including token standards (ERC20, ERC721, ERC1155), access control (Ownable, AccessControl), security primitives (Pausable, ReentrancyGuard), or any OZ extension. Covers library-first integration, pattern discovery from installed source, and version-safe development.
- License 许可
- MIT
- 最近更新
- 2026-10-01
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- openzeppelin
- description
- Develop smart contracts using OpenZeppelin Contracts library. Use when the user wants to create or modify Solidity contracts that use OpenZeppelin — including token standards (ERC20, ERC721, ERC1155), access control (Ownable, AccessControl), security primitives (Pausable, ReentrancyGuard), or any OZ extension. Covers library-first integration, pattern discovery from installed source, and version-safe development.
03 SKILL.md 正文
Develop Smart Contracts with OpenZeppelin
Adapted from OpenZeppelin's official skill for Scaffold-ETH 2 Solidity projects.
Prerequisites
Check if ./packages/nextjs/scaffold.config.ts exists directly in the current working directory (do not search subdirectories). If it doesn't exist, this is not a Scaffold-ETH 2 project. Follow the instructions at https://docs.scaffoldeth.io/SKILL.md to scaffold it first. If it exists, continue directly with building.
Detect the Solidity framework flavor:
- If
packages/hardhatexists → Hardhat flavor - If
packages/foundryexists → Foundry flavor
Core Principle: Prefer Library Components Over Custom Code
Before writing ANY contract logic, search the installed OpenZeppelin library for an existing component:
- Exact match exists? Import and use it directly — inherit, override only what's needed
- Close match exists? Import and extend — override only functions the library marks as
virtual - No match? Only then write custom logic. Confirm by browsing the library's directory first
Never hand-write what the library already provides:
- Don't write
require(totalSupply() + amount <= cap)whenERC20Cappedexists - Don't write
require(msg.sender == owner)whenOwnableexists - Don't implement token transfer hooks manually when the library's base contracts handle it
- Don't copy library source into your contract — always import from the dependency so the project gets security updates
Pattern Discovery: Read the Installed Source
APIs, override points, and import syntax change between major versions. Don't assume patterns from memory — always verify by reading the installed source.
Step 1: Identify the installed version and browse the library
Find the OpenZeppelin version and locate the installed source:
- Hardhat: check
packages/hardhat/package.jsonfor@openzeppelin/contractsversion, then browsepackages/hardhat/node_modules/@openzeppelin/contracts/ - Foundry: check
packages/foundry/lib/openzeppelin-contracts/and the remappings inpackages/foundry/foundry.toml
Browse the library's directory structure to discover available components. Key directories inside the OZ contracts root:
token/{ERC20,ERC721,ERC1155}/— token standards and their base implementationstoken/{ERC20,ERC721}/extensions/— Capped, Burnable, Pausable, Permit, Votes, Enumerable, etc.access/— Ownable, AccessControl, AccessManagerutils/— ReentrancyGuard, Pausable, math, structs
Step 2: Read the source file for the component you need
Look at:
- Import syntax: how the library's own files import each other — mirror that style. OZ v5+ uses named imports:
// ✅ import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol"; // ❌ import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; virtualfunctions: only these can be overridden. Functions that were virtual in one version may not be in another- Constructor parameters: what must be passed during deployment
- NatSpec comments:
NOTE: This function is not virtual, {X} should be overridden instead— follow these
Step 3: Extract the minimal integration pattern
From the source, identify only what's needed:
- Imports to add
- Inheritance chain
- Constructor parameters and chaining
- Required overrides (when inheriting multiple contracts that define the same virtual function, you must override it and call
super) - New functions to expose
Step 4: Apply to the user's contract
Integrate into existing code. Check for conflicts: duplicate access control, incompatible inheritance, missing overrides. The Solidity compiler will error if two parent contracts define the same function and you don't explicitly override it.
SE-2 Integration Notes
- OpenZeppelin is pre-installed in both flavors — no additional dependency installation needed
- Contracts:
packages/hardhat/contracts/(Hardhat) orpackages/foundry/contracts/(Foundry) - Deploy scripts:
packages/hardhat/deploy/(Hardhat) orpackages/foundry/script/(Foundry) - Frontend reads contract ABIs from
packages/nextjs/contracts/deployedContracts.ts(auto-generated byyarn deploy)
04 同仓库更多 Skills
x402
Add x402 payment-gated routes to a Scaffold-ETH 2 project. Use when the user wants to: monetize an API with micropayments, add HTTP 402 payment required to routes, gate content behind crypto payments, implement pay-per-call APIs, or integrate the x402 protocol.
why-ethereum
Why build on Ethereum specifically. The AI agent angle — ERC-8004, x402, composability, permissionless deployment. Use when a user asks "should I build on Ethereum?", "why blockchain?", or when an agent needs to recommend a chain for a project.
wallets
How to create, manage, and use Ethereum wallets. Covers EOAs, smart contract wallets, multisig (Safe), and account abstraction. Use this skill whenever you are sending transactions, signing messages, or managing funds. Includes guardrails for safe key handling.
tools
Current Ethereum development tools, frameworks, libraries, RPCs, and block explorers. What actually works today for building on Ethereum. Includes tool discovery for AI agents — MCPs, abi.ninja, Foundry, Scaffold-ETH 2, Hardhat, and more. Use when setting up a dev environment, choosing tools, or when an agent needs to discover what's available.
testing
Smart contract testing with Foundry — unit tests, fuzz testing, fork testing, invariant testing. Use when writing tests for a smart contract.
subgraph
Integrate The Graph subgraph into a Scaffold-ETH 2 project for indexing blockchain events. Use when the user wants to: index contract events with The Graph, add a subgraph, query onchain data with GraphQL, set up a local graph node, or deploy a subgraph to Subgraph Studio.