如何用 npm 和 Foundry 安装 OpenZeppelin Contracts 并在项目中首次引入

如何用 npm 和 Foundry 安装 OpenZeppelin Contracts 并在项目中首次引入【免费下载链接】openzeppelin-contractsOpenZeppelin Contracts is a library for secure smart contract development.项目地址: https://gitcode.com/GitHub_Trending/op/openzeppelin-contracts如果你正在开发智能合约项目需要引入经过社区审核的 ERC20、ERC721 等标准实现和权限控制组件OpenZeppelin Contracts 就是官方文档推荐的方案。本文覆盖两条官方文档README.md 与 docs/modules/ROOT/pages/index.adoc给出的安装路径Hardhat 项目用 npm 安装Foundry 项目用 git 安装然后在你的合约里 import 库中的组件完成首次引入。两条路径任选其一即可不需要同时使用。先了解版本标签latest、dev、nextREADME 用 NPM tag 区分已审计和未审计的版本选择安装命令前需要先了解这张表Tag用途说明latest✅ 已审计版本稳定、已审计的版本。运行npm install openzeppelin/contracts时默认安装的就是这个版本dev 已定稿但未审计功能完整、已通过全部测试可用于生产环境并受 bug bounty 覆盖但尚未完成审计next 预发布候选未定稿的版本用于在版本成为最终dev或latest之前进行测试验证另外 README 用 IMPORTANT 标注了一条版本兼容性规则OpenZeppelin Contracts 用语义化版本表达 API 与存储布局的向后兼容性对可升级合约而言不同大版本之间的存储布局应视为不兼容——例如从 4.9.3 升级到 5.0.0 是不安全的。选择版本时要确认它与你现有合约的存储布局兼容。路径一在 Hardhat 项目中用 npm 安装在你的 Hardhat 项目根目录执行$ npm install openzeppelin/contracts→ 安装最新已审计版本latest。可选分支如果你明确需要未审计但已定稿的版本例如要提前使用新特性官方文档给出的对应命令是$ npm install openzeppelin/contractsdev→ 安装最新未审计版本dev。路径二在 Foundry 项目中用 git 安装在你的 Foundry 项目根目录执行$ forge install OpenZeppelin/openzeppelin-contracts然后必须修改remappings.txt添加这一行映射使openzeppelin/contracts/...形式的 import 指向库中实际存放合约的contracts/目录openzeppelin/contracts/lib/openzeppelin-contracts/contracts/README 对 git 安装方式给出了两条 WARNING属于高频踩坑点安装 via git 时误用master分支是常见错误。master是开发分支应优先使用 tag 化的发行版本因为发布流程中包含master分支不保证的安全措施。Foundry 首次安装的是最新版本但之后执行forge update会改用master分支——升级依赖前需要留意这一点。首次引入import 并继承库中的合约两条安装路径完成后官方文档给出的首次使用方式是直接 import 库中的合约并继承README 的示例是一个 ERC721 可收集品合约文档示例合约名和 symbol 可按需替换pragma solidity ^0.8.20; import {ERC721} from openzeppelin/contracts/token/ERC721/ERC721.sol; contract MyCollectible is ERC721 { constructor() ERC721(MyCollectible, MCO) { } }注意两点示例声明了pragma solidity ^0.8.20;你的编译器版本需要满足这一约束。本仓库自带的文档示例 MyNFT.sol 用的是pragma solidity ^0.8.24;二者都指向 0.8 系列。import 路径以openzeppelin/contracts/开头。npm 安装时该路径由 node_modules 解析Foundry 项目则依赖前面在remappings.txt中添加的映射。路径解析错误的典型表现就是编译期找不到模块。如果你还没有创建过项目README 的 TIP 指向了官方文档中的 Developing Smart Contracts 指南来学习创建新项目和编译合约该指南位于外部文档站仓库内未包含正文。验证安装是否成功安装是否成功最直接的验证方式是编译你刚刚写了 import 的合约Hardhat 项目npx hardhat compile本仓库自己的 package.json 中compile脚本即为hardhat compile。Foundry 项目forge build本仓库通过 foundry.toml 配置 Foundry 构建源码目录为contractslibs包含node_modules与lib。成功条件编译通过openzeppelin/contracts/...的 import 能被解析继承ERC721的合约不报未定义符号。若报路径解析失败按顺序自查npm 路径检查node_modules下是否装了openzeppelin/contractsFoundry 路径检查remappings.txt的映射行是否完整末尾的contracts/不可少。引入后的使用限制README 明确要求为了保持系统安全始终原样使用已安装的代码不要从网上复制粘贴也不要自行修改它。库的设计保证只有你实际使用的合约和函数会被部署不会无故增加 gas 开销。依赖版本变更尤其是 git 安装后执行forge update要意识到 Foundry 会切到master分支这一行为。升级大版本前对照前文 IMPORTANT 中关于存储布局不兼容的说明评估影响。下一步首次引入成功后README 的 Learn More 部分按主题给出了仓库内的继续阅读入口Access Control决定系统中每个动作由谁执行Tokens创建 ERC-20、ERC-721、ERC-1155、ERC-6909 等标准下的资产Utilities通用工具包括防溢出数学运算、签名验证等Backwards Compatibility版本兼容性的详细说明完整的 API 文档由本仓库 contracts/ 目录下的合约源码生成开发过程中可作为查阅参考。【免费下载链接】openzeppelin-contractsOpenZeppelin Contracts is a library for secure smart contract development.项目地址: https://gitcode.com/GitHub_Trending/op/openzeppelin-contracts创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考