# @0xpolygonid/js-sdk 中文文档

规范地址：https://npmcn.com/package/%400xpolygonid/js-sdk/

版本：1\.46\.1
npm 元数据更新时间：2026-09-25T10:11:08.590Z
中文译文更新时间：2026-11-05T19:06:52.337Z
软件包许可：MIT or Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%400xpolygonid/js-sdk
原文对照：https://npmcn.com/package/%400xpolygonid/js-sdk/?lang=original
项目主页：https://github.com/0xPolygonID/js-sdk#readme
源码仓库：https://github.com/0xPolygonID/js-sdk

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

- 包体积（解压后）：21.3 MB，562 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.11\.0
- 运行依赖：17 个
- peer 依赖：rfc4648 1\.5\.4，snarkjs 0\.7\.5，ffjavascript 0\.3\.1，@iden3/js-jwz 1\.12\.2，@iden3/js-crypto 1\.3\.2，@iden3/js-iden3-core 1\.8\.0，@iden3/js-merkletree 1\.5\.1，@iden3/js-jsonld-merklization 1\.7\.2
- 首次发布：2023-02-22T14:02:52.167Z
- 最新版本发布：2026-09-25T10:11:08.404Z
- 近 30 天下载量：45555（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：153（近 12 个月 31 个）

## 中文简介

SDK 用多边形 ID 工作

## 安装

```sh
npm install @0xpolygonid/js-sdk
```

也可以使用：`pnpm add @0xpolygonid/js-sdk`、`yarn add @0xpolygonid/js-sdk`、`bun add @0xpolygonid/js-sdk`

## README

# Privado ID JS SDK (英语)

SDK使用JavaScript和TypeScript语言与Privado ID合作.

## 使用量

安装 :

```bash
npm install @0xpolygonid/js-sdk
```

## 电路

并设置实际电路到 `test/proofs/testdata`

```bash
curl -LO https://circuits.privado.id/latest.zip
```

## 测试

运行单元测试 :

```bash
npm run test
```

注意: mtp / sig / auth / rhs 文件包含集成测试!

要运行它们, 请设置以下变量 :

```bash
export WALLET_KEY="...key in hex format"
export RPC_URL="...url to network rpc node"
export RHS_URL="..reverse hash service url"
export IPFS_URL="url for ipfs"
export STATE_CONTRACT_ADDRESS="state contract address"
export RHS_CONTRACT_ADDRESS="reverse hash service contract address"
```

## 实例

请看 [实例](https://github.com/0xPolygonID/js-sdk-examples) 为参观提供实例.

## 文档

### 生成文档

1.  定义文档存储器的路径, 例如 :
    
    ```typescript
        const DOCS_DIR = '../js-sdk-tutorials/docs/api';
    ```
    
2.  ```bash
         npm run tsc:declaration:watch
    ```
    
3.  ```bash
         npm run doc:watch:website
    ```
    

文档可以找到 [这里](https://0xpolygonid.github.io/js-sdk-tutorials/)

## 许可证

js-sdk是 0xPolygonID 项目版权的一部分 2024 ZKID Labs AG

这个项目根据以下两项之一获得许可证:

-   [Apache 许可证,2.0版本](https://www.apache.org/licenses/LICENSE-2.0) (单位:千美元)[`LICENSE-APACHE`](https://npmcn.com/package/%400xpolygonid/js-sdk/LICENSE-APACHE)(中文(简体) )
-   [麻省理工学院许可证](https://opensource.org/licenses/MIT) (单位:千美元)[`LICENSE-MIT`](https://npmcn.com/package/%400xpolygonid/js-sdk/LICENSE-MIT)(中文(简体) )

随便你.

## 常见问题

### @0xpolygonid/js-sdk 是什么？

SDK 用多边形 ID 工作

### 如何安装 @0xpolygonid/js-sdk？

在项目目录运行 npm install @0xpolygonid/js-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：rfc4648（1\.5\.4）、snarkjs（0\.7\.5）、ffjavascript（0\.3\.1）、@iden3/js-jwz（1\.12\.2）、@iden3/js-crypto（1\.3\.2）、@iden3/js-iden3-core（1\.8\.0）、@iden3/js-merkletree（1\.5\.1）、@iden3/js-jsonld-merklization（1\.7\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @0xpolygonid/js-sdk 支持 TypeScript 吗？

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

### @0xpolygonid/js-sdk 支持 ESM 还是 CommonJS？

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

### @0xpolygonid/js-sdk 需要什么版本的 Node\.js？

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

### @0xpolygonid/js-sdk 可以商用吗？

@0xpolygonid/js-sdk 使用 MIT or Apache-2\.0 许可。可在 MIT、Apache-2\.0 中任选其一遵守。选择 MIT 时，宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @0xpolygonid/js-sdk 的下载量有多少？

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

### @0xpolygonid/js-sdk 还在维护吗？

最新版本 1\.46\.1 发布于 2026/09/25（1 个月前）；至今共发布 153 个版本，其中过去 12 个月发布了 31 个；首次发布于 2023/02/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。