@defuse-protocol/contract-types

中文文档
0.6.4发布于 2026/05/13TypeScriptESM + CJS近 30 天下载 4万

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

中文使用文档
文档目录16 节
  1. 安装
  2. 标准Schema
  3. 与 Schema 图书馆使用
  4. 类验证器( NestJS)
  5. 佐德语Name
  6. 维利博特
  7. ArkType 密码
  8. 使用量
  9. 可用类型
  10. 发展
  11. 先决条件
  12. 构建
  13. 生成类型
  14. 发展模式
  15. 林特
  16. 许可证

@ defuse-protocol/ 合同类型

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

安装

npm install @defuse-protocol/contract-types

标准Schema

验证器是 标准Schema 符合,并与任何接受光谱的库(TanStack Form,Hono,tRPC等)合作. 见 标准-schema.test.ts 用于使用示例.

与 Schema 图书馆使用

类验证器( NestJS)

见 等级验证员. test.ts 联 合 国 ValidateWithSchema 与NestJS验证管相通的装饰.

佐德语Name

现有两个备选方案: zod.test.ts (中文(简体) )数字 :

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

维利博特

见 valibot.test.ts (英语). 互联网档案馆的存檔,存档日期2013-12-02 用于包装功能.

ArkType 密码

见 方舟类型. test.ts 用于包装功能.

使用量

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等)
  • 与合同有关的其他类型来源于《防御议定书》

发展

先决条件

构建

pnpm run build

生成类型

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

重新生成这些类型:

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

发展模式

pnpm run dev

林特

pnpm run lint

许可证

MIT许可证 2025 NEAR基金会

版本与发布记录

@defuse-protocol/contract-types 共发布 20 个版本,首次发布于 2025/06/17;过去 12 个月发布了 12 个版本。

版本发布日期距今
0.6.4latest2026/05/135 个月前
0.6.32026/04/136 个月前
0.6.22026/02/198 个月前
0.6.12026/02/168 个月前
0.6.02026/02/049 个月前
0.5.02026/01/239 个月前

关于 @defuse-protocol/contract-types 的常见问题

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