TypeScript Protobuf for cheqd identity
ℹ️ Overview
The purpose of this @cheqd/ts-proto NPM package is to provide reusable Protobuf definitions for cheqd identity functionality as a reusable package for use in SDKs and apps.
📖 Documentation
Our identity documentation site explains how @cheqd/ts-proto is consumed in Veramo SDK for cheqd (as an example of how this package can be consumed).
Our Discord server is the primary chat channel for our open-source community, software developers, and node operators.
Please reach out to us there for discussions, help, and feedback on the project.
🙋 Find us elsewhere
关于 @cheqd/ts-proto 的常见问题@cheqd/ts-proto 是什么? A TypeScript package for all transpiled cheqd ProtoBuf definitions.
如何安装 @cheqd/ts-proto? 在项目目录运行 npm install @cheqd/ts-proto,或使用 pnpm add / yarn add / bun add。
@cheqd/ts-proto 支持 TypeScript 吗? 该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/cheqd__ts-proto 是否存在。
@cheqd/ts-proto 支持 ESM 还是 CommonJS? 以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@cheqd/ts-proto 需要什么版本的 Node.js? package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@cheqd/ts-proto 可以商用吗? @cheqd/ts-proto 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。
@cheqd/ts-proto 的下载量有多少? 根据 npm 官方下载统计,@cheqd/ts-proto 在 2026/10/10 – 2026/11/08 这 30 天内被下载 9,620 次,日均约 321 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@cheqd/ts-proto 还在维护吗? 最新版本 4.2.1 发布于 2026/03/10(8 个月前);至今共发布 102 个版本,其中过去 12 个月发布了 7 个;首次发布于 2022/07/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。