# @3id/connect 中文文档

规范地址：https://npmcn.com/package/%403id/connect/

版本：0\.4\.1
npm 元数据更新时间：2024-10-23T15:44:27.120Z
中文译文更新时间：2026-11-08T07:24:15.468Z
软件包许可：\(Apache-2\.0 OR MIT\)

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

原始 npm 页面：https://www.npmjs.com/package/%403id/connect
原文对照：https://npmcn.com/package/%403id/connect/?lang=original
项目主页：https://github.com/ceramicstudio/js-3id#readme
源码仓库：https://github.com/ceramicstudio/js-3id

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

- 包体积（解压后）：12.7 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=14\.14
- 运行依赖：8 个
- 首次发布：2021-04-16T21:59:56.242Z
- 最新版本发布：2022-04-19T16:47:28.879Z
- 近 30 天下载量：1872（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

3ID 的账户管理

## 安装

```sh
npm install @3id/connect
```

也可以使用：`pnpm add @3id/connect`、`yarn add @3id/connect`、`bun add @3id/connect`

## README

# 3ID 连接

iframe中3ID用户账户管理. 方便访问提供商的方法,特别是 [三指针](https://github.com/ceramicstudio/js-3id-did-provider) 在浏览器中。 它允许用户认证,管理,链接和允许他们的3ID密钥到应用程序. 图书馆 [js-3id-did-professor 提供商(提供商)](https://github.com/ceramicstudio/js-3id-did-provider) 处理大多数操作,母窗口(应用程序)通过一个 RPC 层与 iframe 服务通信。 目前只有3id-connect@next和3idconnect.org提供3id-connect与陶瓷支持.

## 使用

```
npm install 3id-connect@next
```

Eetheum供应商和相关认证提供者的用法实例.

```js
import { ThreeIdConnect, EthereumAuthProvider } from '@ceramicstudio/3id-connect'

// assuming ethereum provider available or on window
const addresses = await provider.enable()

const authProvider = new EthereumAuthProvider(provider, addresses[0])
await threeIdConnect.connect(authProvider)

const didProvider = await threeIdConnect.getDidProvider()

// now consume didProvider in ceramic clients, idx, dids libraries, etc
```

## 结构

-   **弧线** - 客户和iframe的核心逻辑和消费界面
    -   **/ 三相连接. ts** - 应用程序接口(RPC客户端)来装入iframe并返回3ID提供者.
    -   **/连接服务.ts** - 身份钱包实例和处理请求的 RPC “服务器”
    -   **/提供 Proxy.ts** - 是否通过 RPC 层转发请求的提供者接口
    -   **/自动提供** - 3ID 连接(客户端) 消耗一个认证提供者,可以执行认证提供者,以支持许多不同的块链账户和认证方法
        -   **/摘要Auth 提供.ts** - 用于执行认证提供者的接口
        -   **/随后提供.ts** - Ethereum 认证提供者,与ethereum账户连接和认证
-   **框架** iframe和流量的设计资产
-   **./公开** - 为iframe部署资产

## 发展

克隆和安装依赖性

#### 本地运行 Iframe

```
$ npm run start
```

Iframe将在30001港就地服务。 iframe服务还需要一个陶瓷节点,默认它会寻找一个本地运行的节点. 运行节点的最快方式是与陶瓷CLI.

```
$ npm install -g @ceramicnetwork/cli
& ceramic daemon
```

也可以运行iframe并连接到远程测试网陶瓷节点.

```
$ npm run start:testnet
```

最后将iframe连接到任何陶瓷节点.

```
$ CERAMIC_API=https://yourceramicnode:port npm run start
```

#### 运行演示

Demo应用程序在30000端口上服务,并连接到一个本地运行的iframe,如上所述. Demo 应用程序见于 `/example` 文件夹.

```
$ npm run start:demo
```

也可以将相同的选项传递给具有类似命令的本地iframe.

```
$ npm run start:demo:testnet
// or
$ CERAMIC_API=https://yourceramicnode:port npm run start:demo
```

#### 构建

```
$ npm run build
```

## 维护者

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

## 常见问题

### @3id/connect 是什么？

3ID 的账户管理

### 如何安装 @3id/connect？

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

### @3id/connect 支持 TypeScript 吗？

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

### @3id/connect 支持 ESM 还是 CommonJS？

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

### @3id/connect 需要什么版本的 Node\.js？

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

### @3id/connect 可以商用吗？

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

### @3id/connect 的下载量有多少？

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

### @3id/connect 还在维护吗？

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