Skip to content

docs: clarify operator revocation, validator veto, and #274 leak formula#292

Merged
rvagg merged 2 commits into
mainfrom
rvagg/docs
Jul 3, 2026
Merged

docs: clarify operator revocation, validator veto, and #274 leak formula#292
rvagg merged 2 commits into
mainfrom
rvagg/docs

Conversation

@rvagg

@rvagg rvagg commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

I found this unstaged edit from an audit I did a couple of months ago.

I want to do some refactoring of the docs and figured these are worthwhile additions before I go ahead and propose moving things around.

@rvagg rvagg requested a review from wjmelements June 23, 2026 09:46
@FilOzzy FilOzzy added this to FOC Jun 23, 2026
@github-project-automation github-project-automation Bot moved this to 📌 Triage in FOC Jun 23, 2026
@rjan90 rjan90 moved this from 📌 Triage to 🔎 Awaiting review in FOC Jun 23, 2026
@rjan90 rjan90 added this to the M4.5: GA Fast Follows milestone Jun 23, 2026
@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #292   +/-   ##
=======================================
  Coverage        ?   77.25%           
=======================================
  Files           ?        5           
  Lines           ?      554           
  Branches        ?      107           
=======================================
  Hits            ?      428           
  Misses          ?      121           
  Partials        ?        5           
Flag Coverage Δ
foundry 77.25% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only update to clarify several subtle/“gotcha” behaviors in FilecoinPayV1 around operator revocation scope, validator callbacks during termination, and the lockupUsage leak described in issue #274.

Changes:

  • Clarifies that revoking an operator’s approval flag only affects rail creation, not authorization on existing rails.
  • Documents validator-driven termination failure mode (and impact on the “settle without validation” escape hatch).
  • Expands the #274 phantom lockupUsage explanation and provides an explicit leak formula.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
SPEC.md Adds operator revocation scope notes, validator termination callback caveat, and elaborates the #274 phantom lockupUsage formula/impact.
README.md Adds “revocation scope” warning, documents validator termination limitation, and refines the #274 leak formula explanation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread SPEC.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@github-project-automation github-project-automation Bot moved this from 🔎 Awaiting review to ✔️ Approved by reviewer in FOC Jul 3, 2026
@rvagg rvagg merged commit 825d8ab into main Jul 3, 2026
6 checks passed
@rvagg rvagg deleted the rvagg/docs branch July 3, 2026 11:10
@github-project-automation github-project-automation Bot moved this from ✔️ Approved by reviewer to 🎉 Done in FOC Jul 3, 2026
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