# @decentralized-identity/ion-sdk 中文文档

规范地址：https://npmcn.com/package/%40decentralized-identity/ion-sdk/

版本：1\.0\.4
npm 元数据更新时间：2024-04-25T22:22:11.685Z
中文译文更新时间：2026-11-11T19:03:37.693Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40decentralized-identity/ion-sdk
原文对照：https://npmcn.com/package/%40decentralized-identity/ion-sdk/?lang=original
项目主页：https://github.com/decentralized-identity/ion-sdk#readme
源码仓库：https://github.com/decentralized-identity/ion-sdk

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

- 包体积（解压后）：116 kB，127 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2020-09-26T00:33:51.936Z
- 最新版本发布：2024-04-25T22:22:11.437Z
- 近 30 天下载量：22432（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

ION 脚本 SDK

## 安装

```sh
npm install @decentralized-identity/ion-sdk
```

也可以使用：`pnpm add @decentralized-identity/ion-sdk`、`yarn add @decentralized-identity/ion-sdk`、`bun add @decentralized-identity/ion-sdk`

## README

# 类型脚本/ Java脚本 SDK `did:ion`

-   此 SDK 允许您创建 `did:ion` 准备提交ION节点的操作.
-   也可以使用SDK来创建长式ION DCD.
-   此SDK既兼容节点.js又兼容浏览器.

代码覆盖

![Statements](https://img.shields.io/badge/statements-100%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-100%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-100%25-brightgreen.svg?style=flat)

```
npm i @decentralized-identity/ion-sdk --save
```

## 额外设置

此软件包取决于 [`@noble/ed25519`](https://github.com/paulmillr/noble-ed25519#usage) 财务报告和审定财务报表 [`@noble/secp256k1`](https://github.com/paulmillr/noble-secp256k1#usage) v2,因此一些环境需要额外的步骤:

```ts
// node.js 18 and earlier, needs globalThis.crypto polyfill
import { webcrypto } from 'node:crypto';
// @ts-ignore
if (!globalThis.crypto) globalThis.crypto = webcrypto;

// React Native needs crypto.getRandomValues polyfill and sha256 for `@noble/secp256k1`
import 'react-native-get-random-values';
import { hmac } from '@noble/hashes/hmac';
import { sha256 } from '@noble/hashes/sha256';
secp.etc.hmacSha256Sync = (k, ...m) => hmac(sha256, k, secp.etc.concatBytes(...m));
secp.etc.hmacSha256Async = (k, ...m) => Promise.resolve(secp.etc.hmacSha256Sync(k, ...m));

// React Native needs crypto.getRandomValues polyfill and sha512 for `@noble/ed25519`
import 'react-native-get-random-values';
import { sha512 } from '@noble/hashes/sha512';
ed.etc.sha512Sync = (...m) => sha512(ed.etc.concatBytes(...m));
ed.etc.sha512Async = (...m) => Promise.resolve(ed.etc.sha512Sync(...m));
```

## 常见问题

### @decentralized-identity/ion-sdk 是什么？

ION 脚本 SDK

### 如何安装 @decentralized-identity/ion-sdk？

在项目目录运行 npm install @decentralized-identity/ion-sdk，或使用 pnpm add / yarn add / bun add。

### @decentralized-identity/ion-sdk 支持 TypeScript 吗？

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

### @decentralized-identity/ion-sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @decentralized-identity/ion-sdk 可以商用吗？

@decentralized-identity/ion-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @decentralized-identity/ion-sdk 的下载量有多少？

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

### @decentralized-identity/ion-sdk 还在维护吗？

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