@agentunion/fastaun-browser 0.3.5 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/_packed_docs/AUN_SDK_/351/207/215/346/236/204/345/256/236/346/226/275/350/256/241/345/210/222.md +596 -0
  3. package/_packed_docs/AUN_SDK_/351/207/215/346/236/204/350/256/276/350/256/241/346/226/271/346/241/210_v3.md +1633 -0
  4. package/_packed_docs/CHANGELOG.md +14 -0
  5. package/_packed_docs/INDEX.md +17 -11
  6. package/_packed_docs/KITE_DOCS_GUIDE.md +11 -10
  7. package/_packed_docs/sdk/01-/345/277/253/351/200/237/345/274/200/345/247/213.md +134 -158
  8. package/_packed_docs/sdk/02-WebSocket/345/215/217/350/256/256.md +11 -7
  9. package/_packed_docs/sdk/03-/346/240/270/345/277/203/346/246/202/345/277/265.md +98 -119
  10. package/_packed_docs/sdk/04-/350/277/236/346/216/245/344/270/216/350/256/244/350/257/201.md +147 -374
  11. package/_packed_docs/sdk/05-E2EE/345/212/240/345/257/206/351/200/232/344/277/241.md +153 -153
  12. package/_packed_docs/sdk/06-API/346/211/213/345/206/214.md +163 -1364
  13. package/_packed_docs/sdk/07-/351/224/231/350/257/257/345/244/204/347/220/206.md +71 -91
  14. package/_packed_docs/sdk/08-/346/234/200/344/275/263/345/256/236/350/267/265.md +76 -63
  15. package/_packed_docs/sdk/09-custody-api-manual.md +7 -6
  16. package/_packed_docs/sdk/09-meta-rpc-manual.md +13 -14
  17. package/_packed_docs/sdk/09-storage-rpc-manual.md +89 -0
  18. package/_packed_docs/sdk/AUN_DOCS_GUIDE.md +37 -49
  19. package/_packed_docs/sdk/INDEX.md +72 -98
  20. package/_packed_docs/sdk/README.md +85 -266
  21. package/dist/aid-store.d.ts +64 -0
  22. package/dist/aid-store.d.ts.map +1 -0
  23. package/dist/aid-store.js +855 -0
  24. package/dist/aid-store.js.map +1 -0
  25. package/dist/aid.d.ts +50 -0
  26. package/dist/aid.d.ts.map +1 -0
  27. package/dist/aid.js +106 -0
  28. package/dist/aid.js.map +1 -0
  29. package/dist/auth.d.ts +17 -1
  30. package/dist/auth.d.ts.map +1 -1
  31. package/dist/auth.js +27 -4
  32. package/dist/auth.js.map +1 -1
  33. package/dist/bundle.js +1981 -2048
  34. package/dist/cert-utils.d.ts +26 -0
  35. package/dist/cert-utils.d.ts.map +1 -0
  36. package/dist/cert-utils.js +221 -0
  37. package/dist/cert-utils.js.map +1 -0
  38. package/dist/client.d.ts +93 -58
  39. package/dist/client.d.ts.map +1 -1
  40. package/dist/client.js +775 -170
  41. package/dist/client.js.map +1 -1
  42. package/dist/error-codes.d.ts +25 -0
  43. package/dist/error-codes.d.ts.map +1 -0
  44. package/dist/error-codes.js +31 -0
  45. package/dist/error-codes.js.map +1 -0
  46. package/dist/errors.d.ts +4 -0
  47. package/dist/errors.d.ts.map +1 -1
  48. package/dist/errors.js +4 -0
  49. package/dist/errors.js.map +1 -1
  50. package/dist/index.d.ts +6 -6
  51. package/dist/index.d.ts.map +1 -1
  52. package/dist/index.js +5 -5
  53. package/dist/index.js.map +1 -1
  54. package/dist/keystore/index.d.ts +1 -1
  55. package/dist/keystore/index.d.ts.map +1 -1
  56. package/dist/result.d.ts +19 -0
  57. package/dist/result.d.ts.map +1 -0
  58. package/dist/result.js +10 -0
  59. package/dist/result.js.map +1 -0
  60. package/dist/transport.d.ts +3 -0
  61. package/dist/transport.d.ts.map +1 -1
  62. package/dist/transport.js +17 -2
  63. package/dist/transport.js.map +1 -1
  64. package/dist/types.d.ts +13 -2
  65. package/dist/types.d.ts.map +1 -1
  66. package/dist/types.js +22 -0
  67. package/dist/types.js.map +1 -1
  68. package/dist/v2/e2ee/encrypt-p2p.js +1 -1
  69. package/dist/v2/e2ee/encrypt-p2p.js.map +1 -1
  70. package/dist/version.d.ts +2 -0
  71. package/dist/version.d.ts.map +1 -0
  72. package/dist/version.js +5 -0
  73. package/dist/version.js.map +1 -0
  74. package/package.json +1 -1
@@ -1,74 +1,62 @@
1
- # AUN SDK Python 文档查阅指南
1
+ # AUN SDK 文档查阅指南
2
2
 
3
- AUN SDK 文档在 `docs/sdk/` 下,索引文件 `docs/sdk/INDEX.md` 分三层,**严格按需逐层加载,禁止一次性读取整个索引**。
4
-
5
- 行区间格式:`L43-49` 表示用 Read 工具读取时读取第 43 行到 49 行。
3
+ AUN SDK 文档位于 `docs/sdk/`,索引文件 `docs/sdk/INDEX.md` 分三层:Layer 1 地图、Layer 2 主题索引、Layer 3 单篇摘要。按需逐层读取,避免一次性加载整套文档。
6
4
 
7
5
  ## SDK 文档定位
8
6
 
9
- SDK 文档聚焦核心封装:**认证(`client.auth`)**、**元信息与信任根(`client.meta`)** 和 **E2EE(`client.e2ee`)**。AID 托管是可选 HTTP 服务,查 `10-custody-api-manual.md`。
10
-
11
- 其他业务操作(消息、群组、存储等)通过 `client.call(method, params)` 调用 RPC 方法,参数和响应格式见 `docs/sdk/09-*-rpc-manual.md`;`message.send` / `message.thought.put` / `group.send` / `group.thought.put` 的业务 payload 共用格式见 `docs/sdk/09-payload-reference.md`。
12
-
13
- ## 渐进式查阅流程
14
-
15
- ### Step 1:只读 Layer 1(L7-34)
7
+ 当前 SDK 聚焦三主体模型:
16
8
 
17
- 列出所有文档名和章节行区间。能直接定位目标 → 跳 Step 4。
9
+ - `AIDStore`:注册、加载、列举、解析和证书运维。
10
+ - `AID`:不可变身份值对象,负责签名、验签和 agent.md 签验。
11
+ - `AUNClient`:认证、连接、状态机、事件和 RPC。
18
12
 
19
- ### Step 2:按需读 Layer 2 对应小节
13
+ 业务操作统一通过 `client.call(method, params)` 调用;消息、群组、存储、meta、stream 的参数见 `09-*-rpc-manual.md`。`message.send`、`message.thought.put`、`group.send`、`group.thought.put` 的业务 payload 见 `09-payload-reference.md`。
20
14
 
21
- 仅当 Step 1 不够时,按关键词读:
15
+ ## 渐进式查阅流程
22
16
 
23
- 身份与认证 L40-45 · 连接与状态 L47-52 · E2EE L54-63 · RPC与事件 L65-77 · 配置与存储 L79-85 · 错误处理 L87-90 · AID托管 L45
17
+ ### Step 1:读 Layer 1
24
18
 
25
- ### Step 3:按需读 Layer 3 单篇摘要
19
+ 查看文档地图,能定位目标就直接读目标文档。
26
20
 
27
- 仅当需要某篇详情但不确定读哪个章节时:
21
+ ### Step 2:按主题读 Layer 2
28
22
 
29
- 快速开始 L96-97 · WebSocket协议 L99-100 · 核心概念 L102-103 · 连接与认证 L105-106 · E2EE加密通信 L108-109 · E2EE_V2消息通信时序图 L111-112 · GROUP-E2EE轮换竞态清单 L114-115 · GROUP-E2EE现状对比与改进建议 L117-118 · API参考 L120-121 · 错误处理 L123-124 · 最佳实践 L126-127 · AID托管 L129-130 · 消息Payload L132-133 · 多语言SDK对齐审查 L135-136
23
+ 常见主题:
30
24
 
31
- 大多数问题在摘要层就能解答。
25
+ - 身份与认证:AIDStore / AID / 注册 / 加载 / 证书
26
+ - 连接与状态:AUNClient / 九态状态机 / Gateway / 重连
27
+ - E2EE:默认加密、ProtectedHeaders、P2P / Group V2
28
+ - RPC 与事件:`client.call()`、`client.on()`、RPC 手册
29
+ - 错误处理:Result、异常、错误码、重试
32
30
 
33
- ### Step 4:读原文目标章节
31
+ ### Step 3:读 Layer 3 摘要
34
32
 
35
- 根据前面获得的文档路径和行区间,精确读取对应章节。**只有需要完整分析时才读整篇原文。**
33
+ 不确定哪篇文档包含细节时,先看单篇摘要,再打开原文目标章节。
36
34
 
37
35
  ## 文档总览
38
36
 
39
37
  | 编号 | 文档 | 定位 |
40
38
  |------|------|------|
41
- | 01 | [快速开始](01-快速开始.md) | 安装、配置、最小示例 |
42
- | 02 | [WebSocket协议](02-WebSocket协议.md) | 握手流程、消息格式、裸 WebSocket 示例 |
39
+ | 01 | [快速开始](01-快速开始.md) | 安装、三主体模型、最小示例 |
40
+ | 02 | [WebSocket协议](02-WebSocket协议.md) | 握手流程、消息格式、裸 WebSocket |
43
41
  | 03 | [核心概念](03-核心概念.md) | AID、状态机、认证、E2EE |
44
- | 04 | [连接与认证](04-连接与认证.md) | 认证封装、call()、on()、连接 |
45
- | 05 | [E2EE加密通信](05-E2EE加密通信.md) | E2EE封装、ProtectedHeaders、自定义存储 |
46
- | - | [E2EE_V2消息通信时序图](E2EE_V2消息通信时序图.md) | V2-only 明文/加密 P2P/GROUP 消息主链路 Mermaid 时序图 |
47
- | - | [GROUP-E2EE轮换竞态清单](GROUP-E2EE轮换竞态清单.md) | GROUP epoch key 轮换状态、竞态条件、补测清单 |
48
- | - | [GROUP-E2EE现状对比与改进建议](GROUP-E2EE现状对比与改进建议.md) | 当前 GROUP E2EE 实现定位、成熟方案对比、风险边界、分阶段改进建议 |
49
- | 06 | [API手册](06-API手册.md) | AUNClient / AuthNamespace / MetaNamespace(信任根列表与 issuer root 更新) / E2EEManager |
50
- | 07 | [错误处理](07-错误处理.md) | 错误类层级、错误码、重试 |
51
- | 08 | [最佳实践](08-最佳实践.md) | 幂等、隔离、资源清理 |
52
- | 10 | [AID托管API手册](10-custody-api-manual.md) | 手机号验证码、证书与加密私钥备份恢复、跨设备复制 |
53
- | - | [09-payload-reference](09-payload-reference.md) | `message.send` / `message.thought.put` / `group.send` / `group.thought.put` 共用业务负载格式、类型总览、思考内容、交互卡片/action_card_reply、任务事件、附件引用 |
54
- | - | [多语言SDK使用场景与调用链路对齐审查清单](多语言SDK使用场景与调用链路对齐审查清单.md) | 多语言场景、调用链路、字段对齐、竞态和服务端风险总表 |
42
+ | 04 | [连接与认证](04-连接与认证.md) | AIDStore、连接、网关发现、事件 |
43
+ | 05 | [E2EE加密通信](05-E2EE加密通信.md) | E2EEProtectedHeaders、密钥管理 |
44
+ | 06 | [API手册](06-API手册.md) | AIDStore / AID / AUNClient / 事件 / RPC |
45
+ | 07 | [错误处理](07-错误处理.md) | Result、异常、错误码、重试 |
46
+ | 08 | [最佳实践](08-最佳实践.md) | 幂等、多 AID、资源清理、测试数据 |
47
+ | 09 | `09-*-rpc-manual.md` | 各服务 RPC 参数和响应 |
48
+ | 09 | [AID托管API手册](09-custody-api-manual.md) | 可选 custody HTTP 服务 |
55
49
 
56
50
  ## 常见查阅场景
57
51
 
58
52
  | 场景 | 推荐路径 |
59
53
  |------|----------|
60
- | 首次使用 SDK | 01-快速开始 全文 |
61
- | WebSocket 或其他语言实现 | 02-WebSocket协议 |
62
- | 理解 AID / E2EE 原理 | 03-核心概念 对应章节 |
63
- | 认证 + 连接 + call/on 用法 | 04-连接与认证 |
64
- | 需要加密通信 | 05-E2EE加密通信 |
65
- | 需要查看 E2EE V2 消息主链路时序 | [E2EE_V2消息通信时序图](E2EE_V2消息通信时序图.md) |
66
- | GROUP E2EE 轮换竞态/测试设计 | [GROUP-E2EE轮换竞态清单](GROUP-E2EE轮换竞态清单.md) |
67
- | GROUP E2EE 架构评估/演进路线 | [GROUP-E2EE现状对比与改进建议](GROUP-E2EE现状对比与改进建议.md) |
68
- | 查消息或思考内容 payload 类型和格式 | [09-payload-reference](09-payload-reference.md) |
69
- | 查某个方法的签名 | 06-API手册 |
70
- | 遇到报错需排查 | 07-错误处理 |
71
- | 部署前检查 | 08-最佳实践 |
72
- | AID 证书和加密私钥托管恢复/跨设备复制 | 10-custody-api-manual |
73
- | 查 RPC 方法参数 | `docs/sdk/*-rpc-manual.md` |
74
- | 多语言 SDK 功能 gap / 字段和事件对齐 / 失败分支审查 | [多语言SDK使用场景与调用链路对齐审查清单](多语言SDK使用场景与调用链路对齐审查清单.md) |
54
+ | 首次使用 SDK | [01-快速开始](01-快速开始.md) |
55
+ | 理解新构造入口 | [01-快速开始](01-快速开始.md)、[06-API手册](06-API手册.md) |
56
+ | 注册或加载 AID | [04-连接与认证](04-连接与认证.md) |
57
+ | 状态机和重连 | [03-核心概念](03-核心概念.md)、[04-连接与认证](04-连接与认证.md) |
58
+ | 查方法签名 | [06-API手册](06-API手册.md) |
59
+ | 查消息或群组 RPC | 对应 `09-*-rpc-manual.md` |
60
+ | payload 格式 | [09-payload-reference.md](09-payload-reference.md) |
61
+ | 排查错误 | [07-错误处理](07-错误处理.md) |
62
+ | 写测试或 demo | [08-最佳实践](08-最佳实践.md) |
@@ -1,6 +1,6 @@
1
1
  # AUN SDK 文档索引
2
2
 
3
- > 渐进式三层结构。Layer 1 极简地图,总是加载;Layer 2 概念交叉索引,按主题查找时加载;Layer 3 每篇文档的详细摘要,需要深入时加载。
3
+ > 三层索引:Layer 1 文档地图,Layer 2 主题交叉索引,Layer 3 单篇摘要。
4
4
 
5
5
  ---
6
6
 
@@ -8,129 +8,103 @@
8
8
 
9
9
  | 文档 | 说明 |
10
10
  |------|------|
11
- | [01-快速开始](01-快速开始.md) | 最小示例 · 安装 · 配置 · 核心流程 |
12
- | [02-WebSocket协议](02-WebSocket协议.md) | 握手流程 · 消息格式 · 裸 WebSocket 示例 |
13
- | [03-核心概念](03-核心概念.md) | AID · 连接状态机 · 认证流程 · E2EE |
14
- | [04-连接与认证](04-连接与认证.md) | 创建AID · 连接网关 · 网关发现 · 调用RPC · 事件订阅 |
15
- | [05-E2EE加密通信](05-E2EE加密通信.md) | E2EE加密消息 · ProtectedHeaders · 会话管理 · 自定义密钥存储 |
16
- | [E2EE_V2消息通信时序图](E2EE_V2消息通信时序图.md) | V2-only 明文/加密 P2P/GROUP 消息主链路 · Mermaid 时序图 |
17
- | [GROUP-E2EE轮换竞态清单](GROUP-E2EE轮换竞态清单.md) | GROUP epoch key 轮换状态 · 竞态条件 · 补测清单 |
18
- | [GROUP-E2EE现状对比与改进建议](GROUP-E2EE现状对比与改进建议.md) | 当前 GROUP E2EE 实现定位 · 成熟方案对比 · 风险边界 · 分阶段改进建议 |
19
- | [06-API手册](06-API手册.md) | AUNClient · AuthNamespace · MetaNamespace(信任根列表 / issuer root 更新) · E2EEManager · 内置事件 · RPC手册索引 |
20
- | [07-错误处理](07-错误处理.md) | 错误类层级 · 错误码速查 · 重试策略 |
21
- | [08-最佳实践](08-最佳实践.md) | 幂等初始化 · 多AID隔离 · 环境变量 · 资源清理 |
22
- | [10-custody-api-manual](10-custody-api-manual.md) | AID 托管 · 手机号验证码 · 备份恢复 · 跨设备复制 |
23
- | [多语言SDK使用场景与调用链路对齐审查清单](多语言SDK使用场景与调用链路对齐审查清单.md) | 多语言场景清单 · 调用链路 · 字段对齐 · 竞态与服务端风险 · 旧清单复审 |
24
-
25
- ### RPC 手册
26
-
27
- | 文档 | 说明 |
28
- |------|------|
29
- | [09-payload-reference](09-payload-reference.md) | `message.send` / `message.thought.put` / `group.send` / `group.thought.put` 共用业务负载格式 · `payload.type` 类型总览 · 交互卡片/action_card_reply · 任务事件 · 附件引用 |
30
- | [09-group-rpc-manual](09-group-rpc-manual.md) | Group 服务 RPC 接口 · 群组创建/加入/成员管理/设置与分发/消息收发/思考内容 · `payload.type` 负载类型 |
31
- | [09-message-rpc-manual](09-message-rpc-manual.md) | Message 服务 RPC 接口 · 点对点消息发送/拉取/确认/P2P 思考内容 · `payload.type` 负载类型 |
32
- | [09-meta-rpc-manual](09-meta-rpc-manual.md) | Meta 服务 RPC 接口 · ping/status/信任根列表与 PKI 下载端点 |
33
- | [09-storage-rpc-manual](09-storage-rpc-manual.md) | Storage 服务 RPC 接口 · 文件上传/下载/对象管理 |
34
- | [09-stream-rpc-manual](09-stream-rpc-manual.md) | Stream 服务 RPC 接口 · 流式数据传输 |
11
+ | [01-快速开始](01-快速开始.md) | 安装 · 三主体模型 · 最小示例 · 多语言构造 |
12
+ | [02-WebSocket协议](02-WebSocket协议.md) | 握手流程 · JSON-RPC 消息格式 · 裸 WebSocket 示例 |
13
+ | [03-核心概念](03-核心概念.md) | AID · AIDStore · AUNClient · 九态状态机 · E2EE |
14
+ | [04-连接与认证](04-连接与认证.md) | 注册加载 · 认证连接 · 网关发现 · 事件 · agent.md |
15
+ | [05-E2EE加密通信](05-E2EE加密通信.md) | E2EE 消息 · ProtectedHeaders · 密钥管理 · 高级存储 |
16
+ | [E2EE_V2消息通信时序图](E2EE_V2消息通信时序图.md) | V2 P2P/GROUP 明文与加密主链路 |
17
+ | [06-API手册](06-API手册.md) | AIDStore · AID · AUNClient · 事件 · E2EE 高级 API · RPC 索引 |
18
+ | [07-错误处理](07-错误处理.md) | Result · 错误类层级 · 错误码 · 重试 |
19
+ | [08-最佳实践](08-最佳实践.md) | 幂等连接 · AID · 资源清理 · 测试数据保护 |
20
+ | [09-payload-reference](09-payload-reference.md) | message / group / thought payload 格式 |
21
+ | [09-message-rpc-manual](09-message-rpc-manual.md) | P2P 消息 RPC |
22
+ | [09-group-rpc-manual](09-group-rpc-manual.md) | 群组 RPC |
23
+ | [09-storage-rpc-manual](09-storage-rpc-manual.md) | 存储 RPC |
24
+ | [09-meta-rpc-manual](09-meta-rpc-manual.md) | meta RPC 和信任根 |
25
+ | [09-stream-rpc-manual](09-stream-rpc-manual.md) | stream RPC |
26
+ | [09-custody-api-manual](09-custody-api-manual.md) | 可选 AID 托管 HTTP API |
35
27
 
36
28
  ---
37
29
 
38
30
  ## Layer 2:概念交叉索引
39
31
 
40
32
  ### 身份与认证
41
- - **AID 格式与结构** → [03-核心概念](03-核心概念.md)
42
- - **创建 AID** → [04-连接与认证](04-连接与认证.md) · [06-API手册](06-API手册.md)
43
- - **认证流程(挑战-应答)** → [03-核心概念](03-核心概念.md)
44
- - **认证失败处理** → [07-错误处理](07-错误处理.md)
45
- - **AID 证书与加密私钥托管恢复/跨设备复制** → [10-custody-api-manual](10-custody-api-manual.md)
46
-
47
- ### 连接与协议
48
- - **WebSocket 握手协议** → [02-WebSocket协议](02-WebSocket协议.md)
49
- - **状态机(4 状态)** → [03-核心概念](03-核心概念.md)
50
- - **连接网关** → [04-连接与认证](04-连接与认证.md)
51
- - **网关自动发现** → [04-连接与认证](04-连接与认证.md)
52
- - **连接状态事件** → [06-API手册](06-API手册.md)
53
-
54
- ### E2EE 端到端加密
55
- - **E2EE 机制概述** → [03-核心概念](03-核心概念.md)
56
- - **加密消息收发** → [05-E2EE加密通信](05-E2EE加密通信.md)
57
- - **V2-only P2P/GROUP 明文与加密时序** → [E2EE_V2消息通信时序图](E2EE_V2消息通信时序图.md)
58
- - **会话管理** → [05-E2EE加密通信](05-E2EE加密通信.md)
59
- - **GROUP epoch key 轮换竞态/补测清单** → [GROUP-E2EE轮换竞态清单](GROUP-E2EE轮换竞态清单.md)
60
- - **GROUP E2EE 现状对比与演进建议** → [GROUP-E2EE现状对比与改进建议](GROUP-E2EE现状对比与改进建议.md)
61
- - **E2EEManager API** → [06-API手册](06-API手册.md)
62
- - **E2EE 错误类** → [07-错误处理](07-错误处理.md)
63
- - **E2EE 幂等运行** → [08-最佳实践](08-最佳实践.md)
64
-
65
- ### RPC 调用与事件
66
- - **`client.call()` 模式** → [04-连接与认证](04-连接与认证.md)
67
- - **`client.on()` 事件订阅** → [04-连接与认证](04-连接与认证.md)
68
- - **裸 WebSocket RPC 调用** → [02-WebSocket协议](02-WebSocket协议.md)
69
- - **内置事件列表** → [06-API手册](06-API手册.md)
70
- - **RPC 手册索引** → [06-API手册](06-API手册.md)
71
- - **多语言 SDK gap、字段、事件、调用链路对齐审查** → [多语言SDK使用场景与调用链路对齐审查清单](多语言SDK使用场景与调用链路对齐审查清单.md)
72
- - **消息 payload 类型总览与格式约定** → [09-payload-reference](09-payload-reference.md)
73
- - **Group RPC 与群设置、群消息、群思考内容收发** → [09-group-rpc-manual](09-group-rpc-manual.md)
74
- - **Message RPC 与 P2P 消息、P2P 思考内容收发** → [09-message-rpc-manual](09-message-rpc-manual.md)
75
- - **Meta RPC** → [09-meta-rpc-manual](09-meta-rpc-manual.md)
76
- - **Storage RPC** → [09-storage-rpc-manual](09-storage-rpc-manual.md)
77
- - **Stream RPC** → [09-stream-rpc-manual](09-stream-rpc-manual.md)
78
-
79
- ### 配置与存储
80
- - **构造参数** → [01-快速开始](01-快速开始.md)
81
- - **数据目录布局** → [01-快速开始](01-快速开始.md)
82
- - **自定义 KeyStore** → [05-E2EE加密通信](05-E2EE加密通信.md)
83
- - **自定义 SecretStore** → [05-E2EE加密通信](05-E2EE加密通信.md)
84
- - **多 AID 隔离** → [08-最佳实践](08-最佳实践.md)
85
- - **环境变量配置** → [08-最佳实践](08-最佳实践.md)
86
-
87
- ### 错误处理
88
- - **错误类层级** → [07-错误处理](07-错误处理.md)
89
- - **错误码对照表** → [07-错误处理](07-错误处理.md)
90
- - **重试策略** → [07-错误处理](07-错误处理.md)
33
+
34
+ - AID 格式、证书、不可变值对象 → [03-核心概念](03-核心概念.md)
35
+ - `AIDStore.register()` / `load()` / `exists()` / `resolve()` → [04-连接与认证](04-连接与认证.md)、[06-API手册](06-API手册.md)
36
+ - AID 构造约束与多语言入口 → [01-快速开始](01-快速开始.md)、[06-API手册](06-API手册.md)
37
+ - 认证链路和 token → [03-核心概念](03-核心概念.md)、[04-连接与认证](04-连接与认证.md)
38
+ - AID 托管恢复 / 跨设备复制 → [09-custody-api-manual](09-custody-api-manual.md)
39
+
40
+ ### 连接与状态
41
+
42
+ - 九态状态机 → [03-核心概念](03-核心概念.md)
43
+ - `connect()` 选项、长短连接、网关发现 → [04-连接与认证](04-连接与认证.md)
44
+ - capability getter、事件、生命周期 API → [06-API手册](06-API手册.md)
45
+ - 裸 WebSocket 握手 → [02-WebSocket协议](02-WebSocket协议.md)
46
+
47
+ ### E2EE
48
+
49
+ - E2EE 原理和默认行为 → [03-核心概念](03-核心概念.md)
50
+ - ProtectedHeaders、prekey、replay guard → [05-E2EE加密通信](05-E2EE加密通信.md)
51
+ - V2 P2P/GROUP 时序 → [E2EE_V2消息通信时序图](E2EE_V2消息通信时序图.md)
52
+ - 高级 E2EE API → [06-API手册](06-API手册.md)
53
+ - 解密失败排查 → [07-错误处理](07-错误处理.md)
54
+
55
+ ### RPC 与事件
56
+
57
+ - `client.call()` / `client.on()` → [04-连接与认证](04-连接与认证.md)、[06-API手册](06-API手册.md)
58
+ - Message RPC → [09-message-rpc-manual](09-message-rpc-manual.md)
59
+ - Group RPC → [09-group-rpc-manual](09-group-rpc-manual.md)
60
+ - Storage RPC → [09-storage-rpc-manual](09-storage-rpc-manual.md)
61
+ - Meta RPC → [09-meta-rpc-manual](09-meta-rpc-manual.md)
62
+ - Stream RPC → [09-stream-rpc-manual](09-stream-rpc-manual.md)
63
+ - Payload 格式 → [09-payload-reference](09-payload-reference.md)
64
+
65
+ ### 错误与测试
66
+
67
+ - Result 与异常层级 → [07-错误处理](07-错误处理.md)
68
+ - 重试策略 → [07-错误处理](07-错误处理.md)
69
+ - 幂等连接、多 AID、资源清理 → [08-最佳实践](08-最佳实践.md)
70
+ - 集成 / E2E 运行顺序 → [../aun测试运行指南.md](../aun测试运行指南.md)
91
71
 
92
72
  ---
93
73
 
94
- ## Layer 3:文档详细摘要
74
+ ## Layer 3:文档摘要
95
75
 
96
76
  ### 01-快速开始
97
- 入门文档。双客户端最小可运行示例(创建 AID → 认证 → 连接 → 消息收发 → 关闭),pip 安装命令,AUNClient 构造参数,数据目录布局。
77
+
78
+ 说明安装、三主体模型、Python 最小消息收发示例、`AIDStore` / `AID` / `AUNClient` 的职责和 TS/JS/Go 构造约束。
98
79
 
99
80
  ### 02-WebSocket协议
100
- 底层协议细节。连接握手流程(challenge → auth.connect → hello-ok),消息格式(RPC 请求/响应/事件通知),裸 WebSocket 完整示例。适合在其他语言中实现客户端。
81
+
82
+ 说明 Gateway WebSocket 握手、JSON-RPC 请求/响应/通知格式,以及裸 WebSocket 客户端如何借助 SDK 完成 token 获取。
101
83
 
102
84
  ### 03-核心概念
103
- SDK 的核心抽象。AID 域名格式身份及本地密钥对管理;连接状态机及自动重连;认证流程(挑战-应答);E2EE 两级离线加密流程。
104
85
 
105
- ### 04-连接与认证
106
- SDK 高层封装。`register_aid` + `authenticate` 认证流程;`connect` 参数(含自动重连、心跳、令牌刷新);`client.call()` RPC 调用模式;`client.on()` 事件订阅。
86
+ 解释 AID 身份、三主体职责、九态状态机、认证挑战-响应、默认 E2EE 行为和 RPC/事件模型。
107
87
 
108
- ### 05-E2EE加密通信
109
- E2EE 完整收发流程(加密发送 + 监听解密 + 后台消息循环);`protected_headers` 与可验证 `context` 元数据;密钥管理(prekey 缓存 / replay guard / group epoch);自定义 `KeyStore` / `SecretStore` Protocol。
88
+ ### 04-连接与认证
110
89
 
111
- ### E2EE_V2消息通信时序图
112
- 当前 V2-only 实现下的主通信链路图。覆盖 V2 设备密钥注册、P2P 明文、P2P 加密、GROUP 明文、GROUP 加密五条时序;明确 P2P 加密走 `message.send` 承载 `e2ee.p2p_encrypted`,GROUP 加密走 `group.v2.send` 承载 `e2ee.group_encrypted`,接收端统一通过 V2 pull 后由 SDK 解密。
90
+ 描述 `AIDStore` 注册加载、`AUNClient` 身份加载、显式认证、连接选项、长短连接共存、网关发现、agent.md 和 RPC 调用。
113
91
 
114
- ### GROUP-E2EE轮换竞态清单
115
- GROUP epoch key 两阶段轮换的状态边界和竞态检查项。覆盖 pending 期间成员变更、leader 竞争、分发/ack/commit 失败、stale pending、key recovery、旧 epoch 保留等场景,用于补充测试和实现审查。
92
+ ### 05-E2EE加密通信
116
93
 
117
- ### GROUP-E2EE现状对比与改进建议
118
- 当前 GROUP E2EE 实现的架构评估。对比 Signal Private Groups、WhatsApp Sender Key、Matrix Megolm 和 MLS,明确 AUN 当前处于“内容 E2EE + 服务端可见成员关系”的安全层级;列出旧 epoch key 恢复、signed group state commit、manifest hash / epoch chain 绑定、多设备模型和 epoch 内前向安全等改进方向。
94
+ 覆盖默认加密发送、接收自动解密、ProtectedHeaders、prekey、群 E2EE、replay guard 和高级存储扩展边界。
119
95
 
120
96
  ### 06-API手册
121
- 完整 API 文档。AUNClient 构造函数/属性/方法;AuthNamespace 方法;E2EEManager 方法;内置事件列表;RPC 手册索引。
97
+
98
+ 列出 AIDStore、AID、AUNClient、事件、E2EE 高级 API 和 RPC 手册索引,包含 Python / TS / JS / Go 的主要命名差异。
122
99
 
123
100
  ### 07-错误处理
124
- `AUNError` 基类及子类层级;错误属性;错误码速查表;指数退避重试策略;常见错误场景。
101
+
102
+ 说明 Result 字典、AUNError 异常层级、错误码映射、重试策略和常见错误场景。
125
103
 
126
104
  ### 08-最佳实践
127
- 幂等连接初始化;安全关闭;E2EE 幂等运行;多 AID 隔离;环境变量驱动配置;资源清理。
128
105
 
129
- ### 10-custody-api-manual
130
- AID 托管 HTTP API。通过手机号验证码上传和下载 AID 证书、客户端加密后的私钥密文;定义 `send-code`、`bind-phone`、`restore-phone` 主流程;补充旧设备 AID token 授权的跨设备复制流程、CT 记录要求及安全边界。
106
+ 给出幂等加载身份、连接、关闭、多 AID 管理、protected_headers、Flow Control 和测试数据保护建议。
131
107
 
132
- ### 09-payload-reference
133
- `message.send`、`message.thought.put`、`group.send` 和 `group.thought.put` 共用的业务 payload 约定。包含 `payload.type` 类型总览、信封字段边界、公共辅助字段、提及语义、`thought` 思考内容、群消息 `dispatch_mode`、各类型字段格式、交互卡片及 `action_card_reply`、`status` / `event` 任务生命周期约定、附件引用规范和降级处理建议。
108
+ ### 09-*-rpc-manual
134
109
 
135
- ### 多语言SDK使用场景与调用链路对齐审查清单
136
- 多语言 SDK 与服务端的总审查文档。覆盖使用场景清单、主调用链路、错误/超时/竞态分支、字段与事件对齐矩阵、高影响问题总表,以及旧清单复审结论。
110
+ 各业务服务的 RPC 参数、响应和错误语义。SDK 不为每个 RPC 提供一层业务 wrapper,应用直接通过 `client.call()` 调用。