# 3id-blockchain-utils 中文文档

规范地址：https://npmcn.com/package/3id-blockchain-utils/

版本：1\.3\.1
npm 元数据更新时间：2022-04-04T10:21:38.516Z
中文译文更新时间：2026-11-07T02:08:26.993Z
软件包许可：\(Apache-2\.0 OR MIT\)

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

原始 npm 页面：https://www.npmjs.com/package/3id-blockchain-utils
原文对照：https://npmcn.com/package/3id-blockchain-utils/?lang=original

弃用说明：This package has been replaced by @ceramicnetwork/blockchain-utils-linking and @ceramicnetwork/blockchain-utils-validation

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

- 包体积（解压后）：112 kB，53 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- 首次发布：2019-11-11T09:43:47.302Z
- 最新版本发布：2020-12-16T02:36:53.765Z
- 近 30 天下载量：2079（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 0 个）

## 中文简介

3ID 的区块链曲率

## 安装

```sh
npm install 3id-blockchain-utils
```

也可以使用：`pnpm add 3id-blockchain-utils`、`yarn add 3id-blockchain-utils`、`bun add 3id-blockchain-utils`

## README

# 3id- block 链式

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) [![CircleCI](https://img.shields.io/circleci/project/github/ceramicnetwork/js-3id-blockchain-utils.svg?style=for-the-badge)](https://circleci.com/gh/ceramicnetwork/js-3id-blockchain-utils) [![npm](https://img.shields.io/npm/dt/3id-blockchain-utils.svg?style=for-the-badge)](https://www.npmjs.com/package/3id-blockchain-utils) [![npm](https://img.shields.io/npm/v/3id-blockchain-utils.svg?style=for-the-badge)](https://www.npmjs.com/package/3id-blockchain-utils) [![Codecov](https://img.shields.io/codecov/c/github/ceramicnetwork/js-3id-blockchain-utils.svg?style=for-the-badge)](https://codecov.io/gh/ceramicnetwork/js-3id-blockchain-utils)

此套件包含由 3ID 和 3Box 为创建和校验块链地址的链接而使用的一系列工具.

## 目录标签

-   [安装](https://npmcn.com/package/3id-blockchain-utils/#readme-install)
-   [使用量](https://npmcn.com/package/3id-blockchain-utils/#readme-usage)
-   [支持的块链](https://npmcn.com/package/3id-blockchain-utils/#readme-supported-blockchains)
-   [捐款](https://npmcn.com/package/3id-blockchain-utils/#readme-contributing)
    -   [测试](https://npmcn.com/package/3id-blockchain-utils/#readme-Test)
-   [许可证](https://npmcn.com/package/3id-blockchain-utils/#readme-license)

## 安装

```
$ npm install --save 3id-blockchain-utils
```

## 使用量

导入软件包到您的工程中

```js
import { createLink, validateLink, authenticate } from '3id-blockchain-utils'
```

使用库创建和校验链接 :

```js
const did = 'did:3:bafypwg9834gf...'
const proof = await createLink(did, '0x123abc...', ethereumProvider)
console.log(proof)

const verified = await validateLink(proof)
if (verified) {
  console.log('Proof is valid', proof)
} else {
  console.log('Proof is invalid')
}
```

使用 3ID 认证库 :

```js
await authenticate(message, '0x123abc...', ethereumProvider)
```

## 支持的块链

下面可以看到一个表格,其中列出支持的块链及其提供者对象.

| 区链 | CAIP-2 命名空间 | 支助提供者 |
| --- | --- | --- |
| 以利亚 | [页:1](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-3.md) | 类似元水缸的乙醚供应商 |
| 文件币 | 过滤 | [文件币钱包提供者](https://github.com/openworklabs/filecoin-wallet-provider) |

## 维护者

[@ooed (英语)](https://github.com/oed)

## 添加区块链支持

如果您想要在 3ID 中添加对新块链的支持, 则此位置为此 。 此库使用 [第10条](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-10.md) 以不可知的方式代表账户。 如果想要添加的块链已经不是其中的一部分 [加勒比空间方案](https://github.com/ChainAgnostic/CAIPs) 标准,你按住 确定它在那里.

要开始添加给定块链的支持, 添加路径的文件 : `src/blockchains/<blockchain-name>.js`。本模块需要导出三种功能:

-   `createLink` - 创建一个链接Proof 对象,将指定的账户ID与 DID 连接
-   `validateLink` - 验证给定的链接证明
-   `authenticate` - 签名消息,然后根据签名返回一些 en. 需要确定性

还需要导出一个常数 `namespace`此常数是一个字符串,包含 [CAIP-2 联合国](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md) 链路命名空间 .

请看 `src/blockchains/ethereum.js` 以实例说明如何为 `eip155` CAIP-2命名空间.

最终在区块链中添加支持 `src/index.js`只要把它加入到 `handlers` 阵列.

### 测试

通过运行测试代码 :

```
$ npm test
```

## 许可证

Apache-2.0或麻省理工学院

## 常见问题

### 3id-blockchain-utils 是什么？

3ID 的区块链曲率注意：该包已被作者标记为弃用——This package has been replaced by @ceramicnetwork/blockchain-utils-linking and @ceramicnetwork/blockchain-utils-validation

### 如何安装 3id-blockchain-utils？

在项目目录运行 npm install 3id-blockchain-utils，或使用 pnpm add / yarn add / bun add。

### 3id-blockchain-utils 支持 TypeScript 吗？

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

### 3id-blockchain-utils 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### 3id-blockchain-utils 可以商用吗？

3id-blockchain-utils 使用 \(Apache-2\.0 OR MIT\) 许可。可在 Apache-2\.0、MIT 中任选其一遵守。选择 Apache-2\.0 时，宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### 3id-blockchain-utils 的下载量有多少？

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

### 3id-blockchain-utils 还在维护吗？

最新版本 1\.3\.1 发布于 2020/12/16（5 年前）；至今共发布 19 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/11/11。作者已将其标记为弃用，新项目建议寻找替代方案。