# @0x/contracts-gen 中文文档

规范地址：https://npmcn.com/package/%400x/contracts-gen/

版本：2\.0\.51
npm 元数据更新时间：2026-08-12T18:07:08.873Z
中文译文更新时间：2026-11-06T19:56:04.444Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%400x/contracts-gen
原文对照：https://npmcn.com/package/%400x/contracts-gen/?lang=original
项目主页：https://github.com/0xProject/tools/tree/main/contracts-gen
源码仓库：https://github.com/0xProject/tools

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：44.8 kB，14 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=6\.12
- 运行依赖：11 个
- 首次发布：2019-02-07T14:02:22.113Z
- 最新版本发布：2023-04-07T18:24:26.870Z
- 近 30 天下载量：2419（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：72（近 12 个月 0 个）

## 中文简介

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

## 安装

```sh
npm install @0x/contracts-gen
```

也可以使用：`pnpm add @0x/contracts-gen`、`yarn add @0x/contracts-gen`、`bun add @0x/contracts-gen`

## README

# 合同

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

## 安装

`yarn add -g @0x/contracts-gen`

## 使用量

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

```bash
contracts-gen
```

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

## 它能产生什么

该工具执行下列任务:

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

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

## 捐款

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

请读我们的 [捐款准则](https://npmcn.com/package/CONTRIBUTING.md) 在开始之前.

### 安装依赖关系

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

```bash
yarn config set workspaces-experimental true
```

然后安装依赖关系

```bash
yarn install
```

### 构建

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

```bash
PKG=@0x/contracts-gen yarn build
```

或在变化中不断重建:

```bash
PKG=@0x/contracts-gen yarn watch
```

### 干净

```bash
yarn clean
```

### 林特

```bash
yarn lint
```

## 常见问题

### @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 和提交记录判断。