Skip to content

docs: clarify NatSpec per Halborn 2026-08 audit findings - #1367

Open
Maikol wants to merge 1 commit into
mainfrom
docs/halborn-natspec
Open

Maikol wants to merge 1 commit into
mainfrom
docs/halborn-natspec

Conversation

@Maikol

@Maikol Maikol commented Oct 7, 2026

Copy link
Copy Markdown
Member

Documentation-only follow-up to the Halborn 2026-08 assessment (#1366). No logic changes.

Finding Change
FIND-047 IDataServiceFees.releaseStake: claims are released in creation order; after a dispute period reduction an older unexpired claim can block newer expired ones
FIND-033 IssuanceAllocator header: Issuance Upper Bound invariant excludes intentional retroactive rate application over an undistributed window
FIND-034 RecurringAgreementManager escalation ladder: revoking COLLECTOR_ROLE only blocks discovery; contain a compromised collector by pausing and force-removing its agreements
FIND-021 SubgraphService.acceptProvisionPendingParameters: remove stale "indexer must be registered" requirement (removed in the OZ CR-02 fix)
FIND-045 Authorizable: revocation is permanent
FIND-046 RecurringCollector._isAuthorized: override also governs the onlyAuthorized guard; self-trust branch must not depend on stored authorization state
FIND-029 ISubgraphService.setStakeToFeesRatio: ratio is a plain multiplier, not PPM
FIND-026 Allocation.isStale: threshold is in seconds, not blocks
FIND-044 IAgreementCollector.cancel / IDataServiceAgreements.cancelIndexingAgreementByPayer: active-scope cancel forwards to the data service, which must call back to complete it

Note: comment changes alter the Solidity metadata hash, so compiled bytecode for the affected contracts will differ from what's deployed even though behavior is unchanged.

Documentation-only changes, no logic changes:
- IDataServiceFees.releaseStake: claims released in creation order (FIND-047)
- IssuanceAllocator: issuance upper bound excludes retroactive rate changes (FIND-033)
- RecurringAgreementManager: containing a compromised collector (FIND-034)
- SubgraphService.acceptProvisionPendingParameters: remove stale registration requirement (FIND-021)
- Authorizable: revocation is permanent (FIND-045)
- RecurringCollector._isAuthorized: override also governs onlyAuthorized (FIND-046)
- ISubgraphService.setStakeToFeesRatio: ratio is a plain multiplier (FIND-029)
- Allocation.isStale: threshold is in seconds (FIND-026)
- IAgreementCollector.cancel / IDataServiceAgreements: active-scope cancel callback (FIND-044)
@Maikol Maikol added the audited label Oct 12, 2026
@codecov

codecov Bot commented Oct 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.47%. Comparing base (3488faa) to head (1940caf).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main    #1367    +/-   ##
========================================
  Coverage   91.47%   91.47%            
========================================
  Files          81       81            
  Lines        5326     5326            
  Branches      973     1132   +159     
========================================
  Hits         4872     4872            
  Misses        433      433            
  Partials       21       21            
Flag Coverage Δ
unittests 91.47% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant