# @enbox/dwn-clients 中文文档

规范地址：https://npmcn.com/package/%40enbox/dwn-clients/

版本：0\.4\.40
npm 元数据更新时间：2026-11-12T05:33:18.341Z
中文译文更新时间：2026-11-14T02:18:38.804Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40enbox/dwn-clients
原文对照：https://npmcn.com/package/%40enbox/dwn-clients/?lang=original
项目主页：https://github.com/enboxorg/enbox/tree/main/packages/dwn-clients#readme
源码仓库：https://github.com/enboxorg/enbox

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

- 包体积（解压后）：476 kB，93 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2026-02-20T05:38:49.919Z
- 最新版本发布：2026-11-12T05:33:17.984Z
- 近 30 天下载量：2521（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 61 个）

## 中文简介

客户端库和用于通信的共享类型 [DWN 服务器](https://npmcn.com/package/%40enbox/dwn-server)。 。 。 .

## 安装

```sh
npm install @enbox/dwn-clients
```

也可以使用：`pnpm add @enbox/dwn-clients`、`yarn add @enbox/dwn-clients`、`bun add @enbox/dwn-clients`

## README

# @enbox/dwn-客户端

客户端库和用于通信的共享类型 [DWN 服务器](https://npmcn.com/package/%40enbox/dwn-server)。 。 。 .

## 包含什么

### 运输客户

| 导出 | 说明 |
| --- | --- |
| `HttpDwnRpcClient` | DWN JSON- RPC 端点的 HTTP 客户端 |
| `WebSocketDwnRpcClient` | DWN JSON- RPC 有订阅的 WebSocket 客户端 |
| `EnboxRpcClient` | Transport multixer — 使用连接的集合WebSocket来进行捆绑控制和小字节备份的复制流量 |
| `HttpEnboxRpcClient` | 拥有 D Does RPC 支持的 HTTP 客户端 |
| `WebSocketEnboxRpcClient` | 拥有 Dods RPC 支持的 WebSocket 客户端 |
| `DwnRegistrar` | DWN 租户登记的HTTP客户端(工作挑战防流) |

### JSON-RPC 软件公司

| 导出 | 说明 |
| --- | --- |
| `createJsonRpcRequest` | JSON- RPC 2.0 请求对象的工厂 |
| `createJsonRpcSuccessResponse` | JSON-RPC成功对策工厂 |
| `createJsonRpcErrorResponse` | JSON-RPC 错误反应工厂 |
| `JsonRpcSocket` | JSON-RPC 信件的持续 WebSocket 包装 |

### 共享类型

两者所使用的类型 `@enbox/dwn-server` (服务器端)和客户端:

| 类型 | 说明 |
| --- | --- |
| `ServerInfo` | 满 `/info` 端点响应形状 |
| `ProofOfWorkChallengeModel` | `GET /registration/proof-of-work` 回应 |
| `RegistrationData` | 租户登记数据`did` + 键 `termsOfServiceHash`(中文(简体) ) |
| `RegistrationRequest` | `POST /registration` 请求正文 |
| `JsonRpcRequest` 编号 : `JsonRpcResponse` | JSON-RPC 2.0 信封 |
| `DwnRpcRequest` 编号 : `DwnRpcResponse` | DWN 特定的区域和技术合作请求/答复 |

### 公用事业

| 导出 | 说明 |
| --- | --- |
| `concatenateUrl` | 以精确的一个加入一个基础 URL 和路径段 `/` |
| `DwnServerInfoCacheMemory` | 模拟缓存 `ServerInfo` 带 TTL |

## 使用量

```typescript
import { EnboxRpcClient } from '@enbox/dwn-clients';

const rpc = new EnboxRpcClient();

// Send a DWN request over HTTP
const response = await rpc.sendDwnRequest({
  dwnUrl    : 'https://dwn.example.com',
  targetDid : 'did:dht:abc123',
  message   : recordsWriteMessage,
  data      : dataStream,
});

// Get server info
const info = await rpc.getServerInfo('https://dwn.example.com');
console.log(info.registrationRequirements); // ['proof-of-work-sha256-v0', 'terms-of-service']

// Register a tenant
import { DwnRegistrar } from '@enbox/dwn-clients';
await DwnRegistrar.registerTenant('https://dwn.example.com', 'did:dht:abc123');
```

## 许可证

阿帕奇 - 2.0

## 常见问题

### @enbox/dwn-clients 是什么？

客户端库和用于通信的共享类型 DWN 服务器。 。 。 \.

### 如何安装 @enbox/dwn-clients？

在项目目录运行 npm install @enbox/dwn-clients，或使用 pnpm add / yarn add / bun add。

### @enbox/dwn-clients 支持 TypeScript 吗？

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

### @enbox/dwn-clients 支持 ESM 还是 CommonJS？

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

### @enbox/dwn-clients 可以商用吗？

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

### @enbox/dwn-clients 的下载量有多少？

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

### @enbox/dwn-clients 还在维护吗？

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