Skip to content

docs(checks): resolve cid.contact verification design from PR review#581

Merged
silent-cipher merged 6 commits into
feat/check-cid-contactfrom
biglep/check-cid-contact-docs
May 29, 2026
Merged

docs(checks): resolve cid.contact verification design from PR review#581
silent-cipher merged 6 commits into
feat/check-cid-contactfrom
biglep/check-cid-contact-docs

Conversation

@BigLep
Copy link
Copy Markdown
Contributor

@BigLep BigLep commented May 29, 2026

Summary

Follow-up documentation for PR #580 addressing review feedback on the two-stage IPNI verification design:

  • discoverabilityStatus remains driven only by filecoinpin.contact
  • cidContactVerification replaces cidContactStatus with sub-status-aligned values (success, failure.*, skipped)
  • ipniVerifyMs timer semantics: filecoinpin.contact uses advertisedAt; cid.contact measures incremental propagation from filecoinpin.contact completion
  • Documents sequential cid.contact check rationale (negative caching) and a separate cid.contact Verification lifecycle branch

Test plan

Made with Cursor

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>
@FilOzzy FilOzzy added this to FOC May 29, 2026
@github-project-automation github-project-automation Bot moved this to 📌 Triage in FOC May 29, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
Copy link
Copy Markdown
Contributor Author

@BigLep BigLep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self review

Comment thread docs/checks/data-storage.md
Comment thread docs/checks/data-storage.md
Comment thread docs/checks/events-and-metrics.md
Comment thread docs/checks/events-and-metrics.md
Comment thread docs/checks/events-and-metrics.md Outdated
Comment thread docs/checks/data-storage.md Outdated
Comment thread docs/checks/events-and-metrics.md Outdated
Comment thread docs/checks/events-and-metrics.md Outdated
Comment thread docs/checks/events-and-metrics.md Outdated
@BigLep BigLep self-assigned this May 29, 2026
@BigLep BigLep requested review from SgtPooki and silent-cipher May 29, 2026 06:26
@BigLep BigLep marked this pull request as ready for review May 29, 2026 06:26
Copilot AI review requested due to automatic review settings May 29, 2026 06:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 / ipniVerifyMs documentation to describe sequential indexer verification and updated timer semantics.
  • Reworks the “count related metrics” section and introduces cidContactVerification as a separate outcome from discoverabilityStatus.
  • 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.

Comment thread docs/checks/events-and-metrics.md Outdated
Comment thread docs/checks/events-and-metrics.md Outdated
Comment thread docs/checks/events-and-metrics.md
Comment thread docs/checks/data-storage.md
Comment thread docs/checks/events-and-metrics.md Outdated
Comment thread docs/checks/events-and-metrics.md Outdated
Comment thread docs/checks/events-and-metrics.md
Comment thread docs/checks/data-storage.md
Clarify ipniVerifyMs labels, cidContactVerification skipped emission,
timer anchors on ipniVerificationStart, and source citations.

Co-authored-by: Cursor <cursoragent@cursor.com>
@BigLep
Copy link
Copy Markdown
Contributor Author

BigLep commented May 29, 2026

Incorporated some of the review feedback in 335cf91:

  • Copilot: fixed ipniVerifyMs label docs (value + indexer, not status); cidContactVerification now documents skipped when filecoinpin.contact does not succeed; updated Sources under sub-status meanings; additonaladditional
  • Self-review / feat: add cid.contact ipni verification after filecoinpin.contact check #580: timer-start rules consolidated under ipniVerificationStart; sequence diagram CPNI; clearer cidContactVerification emission rules and cid.contact verification status anchor; expanded dataSetChallengeStatus period-delta note; gauge vs counter intro

Still open for further review — did not take every Copilot suggestion (e.g. full rewrite of the count-metrics section intro).

@silent-cipher
Copy link
Copy Markdown
Collaborator

I've split the changes here into one another pr #583 . It has general metrics docs structure and clarity updates.

Here, I've removed pending cidContactVerification value since skipped already covers the never ran case.

@github-project-automation github-project-automation Bot moved this from 📌 Triage to ✔️ Approved by reviewer in FOC May 29, 2026
@silent-cipher silent-cipher merged commit 2190166 into feat/check-cid-contact May 29, 2026
9 of 14 checks passed
@silent-cipher silent-cipher deleted the biglep/check-cid-contact-docs branch May 29, 2026 12:31
@github-project-automation github-project-automation Bot moved this from ✔️ Approved by reviewer to 🎉 Done in FOC May 29, 2026
silent-cipher added a commit that referenced this pull request Jun 2, 2026
…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>
silent-cipher added a commit that referenced this pull request Jun 3, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🎉 Done

Development

Successfully merging this pull request may close these issues.

4 participants