docs(checks): resolve cid.contact verification design from PR review#581
Conversation
Document cidContactVerification metric, separate cid.contact sub-status, and ipniVerifyMs timer semantics for the two-stage indexer checks. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Pull request overview
Updates Dealbot check documentation to reflect the revised two-stage IPNI verification design (filecoinpin.contact driving discoverability, with a separate cid.contact verification lifecycle and updated metric semantics).
Changes:
- Refines
ipniVerificationComplete/ipniVerifyMsdocumentation to describe sequential indexer verification and updated timer semantics. - Reworks the “count related metrics” section and introduces
cidContactVerificationas a separate outcome fromdiscoverabilityStatus. - Updates Data Storage check docs to explain the rationale and lifecycle timing of the cid.contact cross-check.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/checks/events-and-metrics.md | Updates event/metric definitions and restructures the status/count metrics documentation for the two-stage IPNI design. |
| docs/checks/data-storage.md | Updates Data Storage verification flow docs and adds cid.contact verification lifecycle/status documentation. |
Clarify ipniVerifyMs labels, cidContactVerification skipped emission, timer anchors on ipniVerificationStart, and source citations. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Incorporated some of the review feedback in 335cf91:
Still open for further review — did not take every Copilot suggestion (e.g. full rewrite of the count-metrics section intro). |
|
I've split the changes here into one another pr #583 . It has general metrics docs structure and clarity updates. Here, I've removed |
…ck (#580) * docs: initial cid.contact ipni check design * docs(checks): resolve cid.contact verification design from PR review (#581) * docs(checks): resolve cid.contact verification design from PR review Document cidContactVerification metric, separate cid.contact sub-status, and ipniVerifyMs timer semantics for the two-stage indexer checks. Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): link pullCheckStatus values to pull-check spec Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): address PR review on cid.contact metrics docs Clarify ipniVerifyMs labels, cidContactVerification skipped emission, timer anchors on ipniVerificationStart, and source citations. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: split #581 * moved to another pr * docs: remove pending cidContactVerification state --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: silent-cipher <puspendramahariya@gmail.com> * feat(ipni): add cid.contact verification * chore: address copilot comments * chore: address pr comment --------- Co-authored-by: Steve Loeppky <biglep@filoz.org> Co-authored-by: Cursor <cursoragent@cursor.com>
* docs: initial cid.contact ipni check design * docs(checks): resolve cid.contact verification design from PR review Document cidContactVerification metric, separate cid.contact sub-status, and ipniVerifyMs timer semantics for the two-stage indexer checks. Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): link pullCheckStatus values to pull-check spec Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): address PR review on cid.contact metrics docs Clarify ipniVerifyMs labels, cidContactVerification skipped emission, timer anchors on ipniVerificationStart, and source citations. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: split #581 * docs: improve metrics docs structure and clarity * moved to another pr * docs: remove pending cidContactVerification state * docs(checks): resolve cid.contact verification design from PR review (#581) * docs(checks): resolve cid.contact verification design from PR review Document cidContactVerification metric, separate cid.contact sub-status, and ipniVerifyMs timer semantics for the two-stage indexer checks. Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): link pullCheckStatus values to pull-check spec Co-authored-by: Cursor <cursoragent@cursor.com> * docs(checks): address PR review on cid.contact metrics docs Clarify ipniVerifyMs labels, cidContactVerification skipped emission, timer anchors on ipniVerificationStart, and source citations. Co-authored-by: Cursor <cursoragent@cursor.com> * docs: split #581 * moved to another pr * docs: remove pending cidContactVerification state --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: silent-cipher <puspendramahariya@gmail.com> * feat(ipni): add cid.contact verification * chore: address copilot comments * chore: address pr comment * chore: address pr comment --------- Co-authored-by: Steve Loeppky <stvn@loeppky.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: Steve Loeppky <biglep@filoz.org>
Summary
Follow-up documentation for PR #580 addressing review feedback on the two-stage IPNI verification design:
discoverabilityStatusremains driven only by filecoinpin.contactcidContactVerificationreplacescidContactStatuswith sub-status-aligned values (success,failure.*,skipped)ipniVerifyMstimer semantics: filecoinpin.contact usesadvertisedAt; cid.contact measures incremental propagation from filecoinpin.contact completionTest plan
#cidContactVerification, FAQ) resolvefeat/check-cid-contactbefore feat: add cid.contact ipni verification after filecoinpin.contact check #580 lands onmainMade with Cursor