# @atcute/did-plc 中文文档

规范地址：https://npmcn.com/package/%40atcute/did-plc/

版本：1\.0\.2
npm 元数据更新时间：2026-09-12T06:53:30.028Z
中文译文更新时间：2026-11-07T08:06:33.851Z
软件包许可：0BSD

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

原始 npm 页面：https://www.npmjs.com/package/%40atcute/did-plc
原文对照：https://npmcn.com/package/%40atcute/did-plc/?lang=original
源码仓库：https://tangled.org/did:plc:pljn5qch4tgadongtc7i6qij

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

- 包体积（解压后）：41.3 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：9 个
- peer 依赖：@atcute/cbor ^2\.0\.0，@atcute/cid ^2\.0\.0，@atcute/identity ^2\.0\.0，@atcute/lexicons ^2\.0\.0
- 首次发布：2025-03-13T09:37:39.559Z
- 最新版本发布：2026-09-12T06:53:29.856Z
- 近 30 天下载量：1997（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 7 个）

## 中文简介

验证、类型定义和计划

## 安装

```sh
npm install @atcute/did-plc
```

也可以使用：`pnpm add @atcute/did-plc`、`yarn add @atcute/did-plc`、`bun add @atcute/did-plc`

## README

# @ atcute/did-plc

验证、 签名和与 do:plc 操作交互 .

```sh
npm install @atcute/did-plc
```

id:plc是一种自我认证的DID方法,其中审计日志是真相的来源。 这个 软件包验证操作有适当的签名和链条,并为 创建和提交新的操作.

## 使用量

### 使用客户端

```ts
import { PlcClient } from '@atcute/did-plc';

const client = new PlcClient();

// fetch DID document
const doc = await client.getDocument('did:plc:ragtjsm2j2vknwkz3zp4oxrd');

// fetch current identity state
const state = await client.getState('did:plc:ragtjsm2j2vknwkz3zp4oxrd');

// fetch operation log
const log = await client.getOperationLog('did:plc:ragtjsm2j2vknwkz3zp4oxrd');

// fetch last operation
const lastOp = await client.getLastOperation('did:plc:ragtjsm2j2vknwkz3zp4oxrd');

// submit a signed operation
await client.submitOperation('did:plc:ragtjsm2j2vknwkz3zp4oxrd', signedOperation);
```

### 签名操作

```ts
import { signOperation, signTombstone, deriveDidFromGenesisOp } from '@atcute/did-plc';

// sign an unsigned operation
const signedOp = await signOperation(unsignedOp, rotationKey);

// sign a tombstone
const signedTombstone = await signTombstone(unsignedTombstone, rotationKey);

// derive did:plc from genesis operation
const did = await deriveDidFromGenesisOp(signedGenesisOp);
```

### 验证审计日志

```ts
import { defs, processIndexedEntryLog } from '@atcute/did-plc';
import * as v from 'valibot';

const did = 'did:plc:ragtjsm2j2vknwkz3zp4oxrd';

const response = await fetch(`https://plc.directory/${did}/log/audit`);
const json = await response.json();

const logs = v.parse(defs.indexedEntryLog, json);
const { canonical, nullified } = await processIndexedEntryLog(did, logs);
```

### 正在验证新操作

在向plc.directory提交新操作之前:

```ts
import { validateIncomingOp } from '@atcute/did-plc';

// throws if operation exceeds size limits or has invalid structure
validateIncomingOp(operation);
```

### 检查争议窗口

```ts
import { isDisputePeriodActive, getDisputeCandidates } from '@atcute/did-plc';

// assuming `canonical` from processIndexedEntryLog result above

// find operations that a rotation key can dispute
const candidates = getDisputeCandidates(canonical, 'did:key:z...');

// check if a specific operation can still be disputed (72-hour window)
const entry = canonical.at(-1);
if (entry && isDisputePeriodActive(entry)) {
    // entry is still within the dispute window
}
```

## 常见问题

### @atcute/did-plc 是什么？

验证、类型定义和计划

### 如何安装 @atcute/did-plc？

在项目目录运行 npm install @atcute/did-plc，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@atcute/cbor（^2\.0\.0）、@atcute/cid（^2\.0\.0）、@atcute/identity（^2\.0\.0）、@atcute/lexicons（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atcute/did-plc 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/atcute\_\_did-plc 是否存在。

### @atcute/did-plc 支持 ESM 还是 CommonJS？

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

### @atcute/did-plc 可以商用吗？

@atcute/did-plc 使用 0BSD 许可。几乎没有限制：可自由使用、修改和分发，连保留版权声明也不要求。以上为概括，不构成法律意见，请以许可原文为准。

### @atcute/did-plc 的下载量有多少？

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

### @atcute/did-plc 还在维护吗？

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

