让开源，少一点语言距离。
npm包中文文档

@0x/contracts-gen

中文文档
2.0.51发布于 2023/04/08Apache-2.0TypeScriptCommonJS近 30 天下载 2419

生成智能合同包的锅炉板代码

中文使用文档
中文原文
文档目录8 节
  1. 安装
  2. 使用量
  3. 它能产生什么
  4. 捐款
  5. 安装依赖关系
  6. 构建
  7. 干净
  8. 林特

合同

这个软件包允许您为智能合同包生成锅炉板 TypeScript 代码和配置.

安装

yarn add -g @0x/contracts-gen

使用量

从你的智能合同包中运行它.

contracts-gen

你应该在每次移动合同后运行这个工具, 重新生成锅炉板代码和配置.

它能产生什么

该工具执行下列任务:

  • 读取您的 compiler.json特别是智能合同清单.
  • 创建 wrapper.ts 用于导出所有合同包装的文件.
  • 创建 artifacts.ts 用于输出所有合同文物的文档.
  • 生成 JSON 文物文件列表 tsconfig.json
  • 生成 abi- gen 在 package.json

再说,如果你 compiler.json 它能解决这个名称与相对路径的关系 并将其放在那里. 它还将输出中的所有列表排序为更小更干净的diffs.

捐款

我们欢迎更广泛的社会作出改进和修正! 要在此包中报告错误, 请在此寄存器中创建一个问题 .

请读我们的 捐款准则 在开始之前.

安装依赖关系

如果您没有启用纱线工作空间( Yarn < v1.0) - 启用它们 :

yarn config set workspaces-experimental true

然后安装依赖关系

yarn install

构建

要构建此软件包和它所依赖的所有其他单列波软件包,请从单列波根目录中运行以下内容:

PKG=@0x/contracts-gen yarn build

或在变化中不断重建:

PKG=@0x/contracts-gen yarn watch

干净

yarn clean

林特

yarn lint

版本与发布记录

@0x/contracts-gen 共发布 72 个版本，首次发布于 2019/02/07；过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.51latest2023/04/083 年前
2.0.502023/04/083 年前
2.0.492023/01/263 年前
2.0.482022/10/134 年前
2.0.472022/08/184 年前
2.0.462022/03/164 年前

其他发布通道：protocolV3 → 1.1.0-beta.4。

关于 @0x/contracts-gen 的常见问题

@0x/contracts-gen 是什么？

生成智能合同包的锅炉板代码

如何安装 @0x/contracts-gen？

在项目目录运行 npm install @0x/contracts-gen，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 contracts-gen，可以用 npx contracts-gen 直接运行。

@0x/contracts-gen 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@0x/contracts-gen 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。

@0x/contracts-gen 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js >=6.12。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@0x/contracts-gen 可以商用吗？

@0x/contracts-gen 使用 Apache-2.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

@0x/contracts-gen 的下载量有多少？

根据 npm 官方下载统计，@0x/contracts-gen 在 2026/10/04 – 2026/11/02 这 30 天内被下载 2,419 次，日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@0x/contracts-gen 还在维护吗？

最新版本 2.0.51 发布于 2023/04/08（3 年前）；至今共发布 72 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/02/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。