# @defuse-protocol/contract-types 中文文档

规范地址：https://npmcn.com/package/%40defuse-protocol/contract-types/

版本：0\.6\.4
npm 元数据更新时间：2026-05-20T12:34:39.639Z
中文译文更新时间：2026-11-11T21:08:39.137Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40defuse-protocol/contract-types
原文对照：https://npmcn.com/package/%40defuse-protocol/contract-types/?lang=original
项目主页：https://github.com/defuse-protocol/sdk-monorepo/tree/main/packages/contract-types#readme
源码仓库：https://github.com/defuse-protocol/sdk-monorepo

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

- 包体积（解压后）：2.7 MB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2025-06-17T12:46:58.543Z
- 最新版本发布：2026-05-12T23:09:02.580Z
- 近 30 天下载量：40149（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 12 个）

## 中文简介

这个包提供了Defuse协议合同的TypeScript类型定义. 它包含由Defuse协议合同ABI所衍生的自动生成的TypeScript接口.

## 安装

```sh
npm install @defuse-protocol/contract-types
```

也可以使用：`pnpm add @defuse-protocol/contract-types`、`yarn add @defuse-protocol/contract-types`、`bun add @defuse-protocol/contract-types`

## README

# @ defuse-protocol/ 合同类型

这个包提供了Defuse协议合同的TypeScript类型定义. 它包含由Defuse协议合同ABI所衍生的自动生成的TypeScript接口.

## 安装

```bash
npm install @defuse-protocol/contract-types
```

## 标准Schema

验证器是 [标准Schema](https://standardschema.dev/) 符合,并与任何接受光谱的库(TanStack Form,Hono,tRPC等)合作. 见 [标准-schema.test.ts](https://npmcn.com/package/%40defuse-protocol/contract-types/src/standard-schema.test.ts) 用于使用示例.

## 与 Schema 图书馆使用

### 类验证器( NestJS)

见 [等级验证员. test.ts](https://npmcn.com/package/%40defuse-protocol/contract-types/src/class-validator.test.ts) 联 合 国 `ValidateWithSchema` 与NestJS验证管相通的装饰.

### 佐德语Name

现有两个备选方案: [zod.test.ts (中文(简体) )](https://npmcn.com/package/%40defuse-protocol/contract-types/src/zod.test.ts)数字 :

-   `z.fromJSONSchema()` - 只验证原始结构, 没有 JSON 字符串解析
-   `toZodSchema()` 包装 - 校验和剖析内部 JSON 字符串

### 维利博特

见 [valibot.test.ts (英语). 互联网档案馆的存檔,存档日期2013-12-02](https://npmcn.com/package/%40defuse-protocol/contract-types/src/valibot.test.ts) 用于包装功能.

### ArkType 密码

见 [方舟类型. test.ts](https://npmcn.com/package/%40defuse-protocol/contract-types/src/arktype.test.ts) 用于包装功能.

## 使用量

```typescript
import { Intent } from '@defuse-protocol/contract-types';

// Use the generated types in your application
const transferIntent: Intent = {
  intent: "transfer",
  receiver_id: "receiver.near",
  tokens: {
    "token.near": "1000000000000000000000000"
  }
};
```

## 可用类型

此套件会导出以下类型 :

-   `Intent` - 各种意图行动的类型(转让、添加 public key、去除 public key等)
-   与合同有关的其他类型来源于《防御议定书》

## 发展

### 先决条件

-   [菲律宾](https://pnpm.io/) (v10.14.0) (中文(简体) )

### 构建

```bash
pnpm run build
```

### 生成类型

这些类型由Defuse协议合同ABI自动生成,使用脚本 `scripts/gen-defuse-types.ts`。此脚本从合同ABI中提取类型定义,并将其转换为TypeScript接口.

重新生成这些类型:

```bash
# Run the type generation script
cd packages/contract-types
pnpm run gen-defuse-types
```

### 发展模式

```bash
pnpm run dev
```

### 林特

```bash
pnpm run lint
```

## 许可证

MIT许可证 2025 NEAR基金会

## 常见问题

### @defuse-protocol/contract-types 是什么？

这个包提供了Defuse协议合同的TypeScript类型定义\. 它包含由Defuse协议合同ABI所衍生的自动生成的TypeScript接口\.

### 如何安装 @defuse-protocol/contract-types？

在项目目录运行 npm install @defuse-protocol/contract-types，或使用 pnpm add / yarn add / bun add。

### @defuse-protocol/contract-types 支持 TypeScript 吗？

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

### @defuse-protocol/contract-types 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @defuse-protocol/contract-types 可以商用吗？

@defuse-protocol/contract-types 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @defuse-protocol/contract-types 的下载量有多少？

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

### @defuse-protocol/contract-types 还在维护吗？

最新版本 0\.6\.4 发布于 2026/05/13（5 个月前）；至今共发布 20 个版本，其中过去 12 个月发布了 12 个；首次发布于 2025/06/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。