@enbox/dwn-clients

中文文档

0.4.40发布于 2026/11/12Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 2521

Client libraries and shared types for communicating with DWN Servers.

文档目录7 节

What's Included
Transport Clients
JSON-RPC
Shared Types
Utilities
Usage
License

@enbox/dwn-clients

Client libraries and shared types for communicating with DWN Servers.

What's Included

Transport Clients

Export	Description
`HttpDwnRpcClient`	HTTP client for DWN JSON-RPC endpoints
`WebSocketDwnRpcClient`	WebSocket client for DWN JSON-RPC with subscriptions
`EnboxRpcClient`	Transport multiplexer — uses a connected pooled WebSocket for bounded control and small byte-backed replication traffic
`HttpEnboxRpcClient`	HTTP client with DID RPC support
`WebSocketEnboxRpcClient`	WebSocket client with DID RPC support
`DwnRegistrar`	HTTP client for DWN tenant registration (proof-of-work challenge flow)

JSON-RPC

Export	Description
`createJsonRpcRequest`	Factory for JSON-RPC 2.0 request objects
`createJsonRpcSuccessResponse`	Factory for JSON-RPC success responses
`createJsonRpcErrorResponse`	Factory for JSON-RPC error responses
`JsonRpcSocket`	Persistent WebSocket wrapper for JSON-RPC messaging

Shared Types

Types used by both @enbox/dwn-server (server-side) and clients:

Type	Description
`ServerInfo`	Full `/info` endpoint response shape
`ProofOfWorkChallengeModel`	`GET /registration/proof-of-work` response
`RegistrationData`	Tenant registration data (`did` + `termsOfServiceHash`)
`RegistrationRequest`	`POST /registration` request body
`JsonRpcRequest` / `JsonRpcResponse`	JSON-RPC 2.0 message envelopes
`DwnRpcRequest` / `DwnRpcResponse`	DWN-specific RPC request/response

Utilities

Export	Description
`concatenateUrl`	Join a base URL and path segment with exactly one `/`
`DwnServerInfoCacheMemory`	In-memory cache for `ServerInfo` with TTL

Usage

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');

License

Apache-2.0

版本与发布记录

@enbox/dwn-clients 共发布 61 个版本，首次发布于 2026/02/20；过去 12 个月发布了 61 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本	发布日期	距今
`0.4.40`latest	2026/11/12	1 天前
`0.4.39`	2026/11/07	7 天前
`0.4.38`	2026/11/01	13 天前
`0.4.37`	2026/10/23	22 天前
`0.4.36`	2026/10/21	24 天前
`0.4.35`	2026/09/18	1 个月前

关于 @enbox/dwn-clients 的常见问题

@enbox/dwn-clients 是什么？

Client libraries and shared types for communicating with DWN Servers.

如何安装 @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 和提交记录判断。