docs: 澄清自动归集任务与钱包配置语义 - #384
Conversation
Reconstructed from ~/.workmate/playbook-traces/run_8d40a6d96746/events.jsonl (25 captured Edit/Write ops replayed). Worktree was deleted on success before the changes were committed; all real doc edits recovered intact.
- CN upgrade-guide.mdx: restore WaaS 2.0 API operation names to English (Create wallet, Create addresses in wallet, Transfer token, Speed up transaction, Drop transaction, Cancel transaction, Call smart contract, Sign message, List all transactions, Get transaction information) - transfer-routing.mdx EN+CN: add note clarifying force_internal / force_external are mutually exclusive, and add JSON code examples showing force-Cobo-Loop, force-on-chain, and default routing - status.mdx EN+CN: update FailedSignerTimeout remedy to specify retry operation by original transaction type (Transfer token / Call smart contract / Sign message) instead of always pointing to Transfer token Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
关联 api-spec PR:https://github.com/CoboGlobal/developer-site-waas2/pull/2310 |
运行过程记录(自动生成)本评论记录本次 doc 运行的内部过程,便于审查每个结论的来源。 1. 意图(确认后)来源:本地 issue-analysis 文件 调查并修复以下文档问题:
2. 探索发现(按仓库 × explorer)原始并行探索 findings 超过 GitHub 单条评论限制;按规范,本节截断为每个 explorer 的
|
cobosteven
left a comment
There was a problem hiding this comment.
Verdict: REQUEST_CHANGES
总评
事实核查维度确认 PR 的 auto-sweep 异步/状态/enable/pause/充币地址限制语义与 custody 源码一致,未发现捏造或错误的 error code / 状态码;cobo-libs 与本 PR 无关。但当前仍有 4 个 must_fix:3 个 v2_cn API operation 名称被翻译,以及 dev_openapi.yaml 中 Portal 修复说明缺少可执行点击路径。
must_fix
- (双语一致性)
v2_cn/guides/transactions/manage-transactions.mdxcancel-transaction 条目(diff line 411 / 当前 line 24):链接标签被改为 [取消交易],但 API operation 名称不得翻译。请改回 [Cancel transaction],与 EN 保持一致。 - (双语一致性)
v2_cn/guides/transactions/manage-transactions.mdxspeed-up-transaction 条目(diff line 420 / 当前 line 56):链接标签被改为 [加速交易]。请改回 [Speed up transaction]。 - (双语一致性)
v2_cn/guides/transactions/manage-transactions.mdxdrop-transaction 条目(diff line 429 / 当前 line 72):链接标签被改为 [放弃交易]。请改回 [Drop transaction]。 - (标准合规)
v2/cobo_waas2_openapi_spec/dev_openapi.yaml中enable_auto_sweep描述(diff lines 91-95、109-110、125-130、145-150):说明开发者在 Cobo Portal 管理 pause/resume 或恢复充币地址活动,但没有提供精确 Portal 点击路径。请补充可执行路径,例如Log in to Cobo Portal > ... > click ...。
|
已在最新推送
以下问题未在本 docs 修订中宣称已修复,仍需对应开发团队处理:
验证结果:OpenAPI validation 通过;Mintlify 仅报告既有的 autosweep navigation target 缺失警告。 运行过程记录(自动生成)
|
cobosteven
left a comment
There was a problem hiding this comment.
Verdict: REQUEST_CHANGES
总评
事实核查确认全部 22 条代码引用均准确,行为声明均有源码支撑。但本 PR 仍有 2 项 must_fix:AutoSweepTask.failed_reasons 描述缺乏可操作排障指引,以及中文指南删除分页章节但英文版仍保留,造成 EN↔CN 内容漂移。
must_fix
[1] v2/cobo_waas2_openapi_spec/dev_openapi.yaml — AutoSweepTask.failed_reasons 描述违反 WHY/可操作性规则
添加的诊断类别 The sweep transaction could not be created. 仅重述失败结果;Chain-specific fee-handling requirements were not met, for example, on TRON 和 Fee Station declined to fund the transaction 也过于模糊,未说明开发者可检查的机制(如 gas/资源要求、费用上限、Fee Station 配额、Cobo Portal 路径)。
请为每个稳定类别补充可执行检查,例如轮询 Get auto-sweep task details(传入 task_id)、检查源地址 gas 余额、或通过 Cobo Portal → Wallets → [Wallet] → Settings 确认 Fee Station 配置;若 failed_reasons 仅返回自由文本,则删除固定类别说明,改为说明其不可解析性。
[2] v2_cn/guides/transactions/manage-transactions.mdx — 删除分页章节导致 EN↔CN 内容漂移
CN 文件删除了 ## 对交易列表分页 / ### 分页操作步骤 章节(含 before、after、direction、pagination、limit、total_count 等字段说明),但 EN 文件 v2/guides/transactions/manage-transactions.mdx 的 ## Paginate the transaction list / ### Pagination walkthrough 章节仍保留。
请恢复 CN 分页章节,或同步删除/更新 EN 对应章节。
关联来源
意图
本次变更核实并澄清自动归集任务的失败原因、手动任务阈值、异步状态与交易创建语义,避免用户将
Submitted或空transaction_ids误解为已经完成归集。同步说明启用 auto-sweep 后的充币地址限制、不可逆启用语义,以及暂停自动触发与禁用能力的区别。对于后端未提供的Failed状态和failed_type字段,不做结构性 API 变更,而是明确现有客户端判断契约。变更摘要
v2/cobo_waas2_openapi_spec/dev_openapi.yaml:同步 auto-sweep 源 OpenAPI 说明,完善failed_reasons、transaction_ids、AutoSweepTaskStatus、min_balance_threshold和钱包enable_auto_sweep的语义及限制;本 PR 仅携带同步后的文件,源改动将在developer-site-waas2单独提交。v2/guides/custodial-wallets/get-started-asset-wallets.mdx:更新英文自动归集指南,说明按需任务的异步处理、执行检查、联合轮询字段和下游交易状态查询,并删除未经证实的超时自动取消描述。v2_cn/guides/custodial-wallets/get-started-asset-wallets.mdx:同步更新中文自动归集指南,并保留 API operation、字段与 enum 标识符原文。v2/guides/overview/changelog.mdx:更新英文变更记录,说明Submitted、transaction_ids与failed_reasons的联合判断方式。v2_cn/guides/overview/changelog.mdx:同步更新中文变更记录。关联 PR
developer-site-waas2,后续步骤将自动创建独立 PR,并以评论形式回链本 PR。代码证据
custody/waas2/auto_sweep/enum/task.py:17:定义余额不足、费用上限、待处理任务、最低余额、Fee Station 拒绝、交易失败与 Other 等内部失败类别,支撑failed_reasons的语义分类。custody/waas2/auto_sweep/processor/policy.py:1231、custody/waas2/auto_sweep/processor/policy.py:1274、custody/waas2/auto_sweep/processor/policy.py:1283:分别证明待处理 UTXO 交易、扣费后余额不足与费用上限会阻止归集。custody/waas2/auto_sweep/processor/policy.py:1379、custody/waas2/auto_sweep/processor/policy.py:1518:证明 TRON 费用检查和 Fee Station 配额拒绝会形成客户端可见诊断原因。custody/waas2/auto_sweep/services/auto_sweep_task_service.py:240:未处理异常通过str(e)序列化,证明failed_reasons是不应按固定文本解析的自由文本诊断信息。custody/waas2/auto_sweep/controllers/dev/task.py:62、custody/waas2/auto_sweep/processor/policy.py:991、custody/waas2/auto_sweep/processor/policy.py:1422:证明手动任务按指定 token 执行,并逐地址评估请求中的min_balance_threshold。custody/waas2/auto_sweep/controllers/dev/task.py:124:公开响应仅序列化Submitted、TransactionCreated,且transaction_ids来自实际任务记录,支撑联合检查三个响应字段。custody/waas2/auto_sweep/enum/policy.py:35:持久化生命周期只有Submitted、Sent与TransactionCreated,证明不应向公开 enum 添加Failed。custody/waas2/auto_sweep/services/auto_sweep_task_service.py:259:超时取消只处理已有交易记录的任务,不支持“无交易记录任务必定超时取消”的文档承诺。custody/waas2/mpc/processors/utils.py:431、custody/waas2/mpc/processors/dev/transaction.py:1143、custody/waas2/mpc/processors/dev/transaction.py:1483:证明启用 auto-sweep 后,充币地址默认受公开转账和合约调用限制。custody/waas2/mpc/processors/dev/mpc_wallet.py:307、custody/waas2/web3/processors/dev/wallet.py:255:检查到的 MPC 与 Custodial Web3 更新路径均只持久化启用状态,支撑enable_auto_sweep的单向启用语义。custody/waas2/mpc/processors/mpc.py:1954、custody/waas2/web3/processors/wallet.py:648:其他更新路径仅在enable_auto_sweep为true时更新,证明false不能作为可靠的禁用操作。custody/waas2/auto_sweep/processor/setting.py:271、custody/waas2/auto_sweep/processor/policy.py:752:暂停通过独立的STOP_AUTO_SWEEP设置保存,并仅抑制后续策略触发,证明暂停不等同于撤销启用。无